Showing posts with label Swift. Show all posts
Showing posts with label Swift. Show all posts

Monday, June 29, 2020

SwiftPM and Resources

Last year I wrote about the sad state of dependency management for iOS projects. Later this year Xcode 12 will be released and it will address a couple of the big limitations of the Swift Package Manager (SwiftPM). I won't go into much detail about how they work, but you can watch a couple of great (and short!) WWDC videos about Resources and Localization and Binary Frameworks.

Last week I spent some time with the Xcode 12 beta trying the new support for resources, and even had a few great lab appointments with Apple engineers. Here are some observations. 

Resources

Xcode does a good job of bundling resources found among your sources, if it knows what to do with them. It automatically processes things like Xibs and asset catalogs. For things that it doesn't know about, you can tell it what to do in a list of resources for each target in Package.swift. See the aforementioned video for details. 

Bundle.module

If you are converting an existing framework that contains resources to SwiftPM, you'll have to make some adjustments. In a framework that is built from a traditional Xcode project, it is common to load resources such as images and Xibs using Bundle(for: AnyClass). This initializer does not work in a Swift package. Instead, Swift package code should use Bundle.module. While this is new with Xcode 12, thankfully it is backward deployable and can by used by iOS versions prior to  iOS 14. 

There is a catch though. Bundle.module is only available when building a Swift package. So, an xcodeproj framework can't use Bundle.module and has to continue to use Bundle(for: AnyClass), but a Swift package can't use Bundle(for: AnyClass) and has to use Bundle.module. This is a problem for many framework vendors that will need to support Carthage and SwiftPM concurrently for some time. It is also a problem for internal frameworks as we work toward SwiftPM, but will continue to build frameworks as Xcode projects until Xcode 12 ships. One solution is to migrate existing code to Bundle.module, and then add something like this to your project: 

#if !SWIFT_PACKAGE
extension Bundle {
    class BundleClass { }
    static let module = Bundle(for: BundleClass.self)
}
#endif

This provides an alternate implementation of Bundle.module when not building with SwiftPM. Perhaps this will be resolved before Xcode 12 ships (FB7792343 for Apple folks). 

Interface Builder

Although Xibs are now being properly copied into the target bundle, I noticed they weren't being loaded properly at runtime. Eventually I determined that I have to uncheck "Inherit Module From Target" for any custom views that are used. 
In order to make sure I caught all instances of this, I edited a lot of Xibs in a text editor. I suspect the need to uncheck "Inherit Module From Target" is a bug (FB7793693). Hopefully it will be fixed eventually. 

Testing... 

The trouble with both the Bundle(for: AnyClass) change and the Interface Builder custom class issue, is that these problems are not caught at compile time. Both result in runtime bugs or crashes. Also, these types of problems are often not covered by unit tests. If you are converting an existing framework with resources to SwiftPM, you'll need to carefully audit the project and test thoroughly. 

A Light at the End of the Tunnel

Many framework vendors already support SwiftPM. Hopefully the new support for resources and binary frameworks will enabled the rest to adopt SwiftPM soon. I look forward to fully embracing SwiftPM later this year. 


Sunday, November 15, 2015

MythTV on the New Apple TV

For years I have wished there was an App Store for the Apple TV. Like most people, I looked forward to things like games or streaming video content beyond the limited offerings bundled with previous version of the Apple TV. I also wanted something else: a MythTV Frontend.

MythTV is an open source project that helps you build your own digital video recorder (DVR). MythTV has a client/server architecture, called Frontend/Backend respectively. Ideally the Backend lives in a wiring closet or server room. A Frontend is attached to each television and plays content stored on the backend.

A MythTV Backend is fairly easy to set up with PC or Mac hardware and a networked television tuner such as HDHomeRun. A MythTV Frontend is more challenging to set up. It usually involves finding hardware that supports video decoding and has proper Linux support. You also need an IR receiver and a remote. Configuring the IR commands can be challenging. I used to tell people that MythTV is more of a hobby than a solution.

That all changed with the new Apple TV.

I received my Apple TV developer kit about six weeks prior to the launch of the New Apple TV. I immediately began building a MythTV application for tvOS. The MythTV Backend has a REST API that provides a great way to access content and data. Things went pretty smoothly and the MythTV app for tvOS was in the App Store on launch day.

Thanks to the New Apple TV and the MythTV app for tvOS, it is now much easier to set up a MythTV system. For the backend you can use MythBuntu, a special build of Ubuntu that has MythTV baked in. Or you can set up a MythTV Backend on a Mac using these instructions. They may seem a bit daunting, but are mostly just commands you can cut and paste into Terminal. You'll also need a HDHomeRun. You don't need one of the new models. Mine is a dual tuner unit that is about 10 years old, pictured above. The older models can be found on eBay for around $50. For the Frontend, just use buy a new Apple TV and install the MythTV app. Now you have a TiVo-like DVR system and you can watch your recordings from any TV in your house.


The MythTV app for tvOS currently has the following features:
  • Recorded programs are listed and multiple episodes of the same show are grouped together. 
  • Top Shelf integration: quickly find and launch a show from the Apple TV home screen.
  • Scrubbing with snapshot thumbnails.
  • Fast-forward supports several speeds.
  • Watch content more quickly with 1.3x fast-forward (good for things like talk shows).
  • Easily skip commercials with 30-second jump forward and 8-second jump back.
  • Pick up where you left off. Playback progress is stored and synced across all your Apple TVs.
  • Delete shows when you are done watching them.
One feature that is not yet ready is the Program Guide. Until this is done you can use MythWeb, a web interface that runs on the MythTV Backend. It allows you to browse listing and manage schedules and recording rules. This works out pretty well because once schedules are set up (TiVo calls them "season passes"), the Backend pretty much runs on autopilot and doesn't need much maintenance.

As more content becomes available from streaming sources, "cutting the cable" becomes more attractive. One of the remaining barriers is recording and "time-shifting" local broadcasts. MythTV and the MythTV app for Apple TV fill this gap.

Apple TV apps can't be viewed in a web browser, but you can see screenshots below.







Thursday, June 11, 2015

Guard is Good (Swift)

Several good fixes and improvements to Swift were introduced at WWDC15 as a part of Swift2 -- the first major update to the excellent Swift programming language. One of these updates was the new `guard` keyword. It immediately resonated with me because I saw that it fixed some pain points that I have often encountered.

Pyramid of Doom


Anyone who has used Swift is familiar with the `if let` construct. It is an elegant way to unwrap an Optional, and do something with the unwrapped value if it is not nil. This leads to code that looks like this:

    func personFromData(data:NSData?) -> Person? {
        if let data = data {
            let json = JSON(data:data) // SwiftyJSON
            if let firstName = json["firstName"].string {
                if let lastName = json["lastName"].string {
                    return Person(firstName:firstName, lastName:lastName)
                }
            }

        }
        return nil
    }

Even in this small example, you can what has been referred to as the Pyramid of Doom.

Swift 1.2, released earlier this year, added support for unwrapping multiple Optional values at once with `if let`. This looks a bit better:

    func personFromData(data:NSData?) -> Person? {
        if let data = data {
            let json = JSON(data:data)
            if let firstName = json["firstName"].string, 
                   lastName = json["lastName"].string 
            {
                return Person(firstName:firstName, lastName:lastName)
            }
        }
        return nil
    }

Note that we couldn't completely collapse the pyramid because we have to convert the NSData to a JSON object, and you can't throw that statement in with the other assignments that are unwrapping Optionals. 

One problem with the examples so far is that there is no error handling. While it's nice to unwrap multiple Optionals at once, sometimes you might need unique error handling for each nil Optional. That means we're back to the Pyramid of Doom, except it's even worse now:
        
    func personFromData(data:NSData?) -> Result<Person, String> {
        if let data = data {
            let json = JSON(data:data)
            if let firstName = json["firstName"].string {
                if let lastName = json["lastName"].string {
                    return Result(value:Person(firstName:firstName, lastName:lastName))
                }
                else {
                    return Result(error:"missing lastName in JSON")
                }
            }
            else {
                return Result(error:"missing firstName in JSON")
            }
        }
        else {
            return Result(error:"where data was nil")
        }
    }

This is really ugly. Even in the small example above you can see that it's hard to associate the error handling code in each else clause with the corresponding `if let` that failed because of a nil Optional. The error handling code for each error condition is in the reverse order of the code that checks for the error conditions. 

Guard all the Things


Guards are kind of like `if let`, but inverted. Instead of using `if let` to unwrap an Optional while testing for nil, use `guard let ... else` to unwrap the Optional. If the Optional is nil, the else clause is executed. You have to return from the else clause. Our example can now be rewritten like this: 


    func personFromData(data:NSData?) -> Result<Person, String {
        guard let theData = data else {
            return Result(error:"data was nil")
        }
        let json = JSON(data:theData)

        guard let firstName = json["firstName"].string else {

            return Result(error:"missing firstName in JSON")
        }
        guard let lastName = json["lastName"].string else {
            return Result(error:"missing lastName in JSON")
        }
        return Result(value:Person(firstName:firstName, lastName:lastName))
    }

This is much better. Observe that the code to deal with errors is next to the error condition that was tested. Also, once all of the error checking is out of the way, the code that continues on for the no-error situation is no longer indented several levels deep. 

Guards can be used to check any condition -- they aren't just tied to Optional unwrapping. For example: 

        guard index <= 3 else {
            return Result(error:"Index out of bounds")
        }

This is not drastically different from what could be done before, however, the nuance is interesting. The alternative looks like this: 

        if index > 3 {
            return Result(error:"Index out of bounds")
        }

The version using `guard` reads better because the expression indicates the success state. It reads more like an assertion. Also, with guard the compiler requires a return in the error clause. A common programming mistake is to log something about the error but forget to return, allowing program execution to continue as though there was not an error. 

Naming Things


In the first code examples above, we used the common convention 
    if let data = data {

With `guard let,` we can no longer do this because the new constant isn't constrained within a new scope. We have to use a different name for the Optional and non-Optional versions of a variable or constant. Naming things is hard, but the benefits of using `guard` are worth it. 

Swift continues to evolve and become even more powerful and enjoyable to use.