Distributed actors transport example, for feature review

Apple

Last update: Jan 2, 2023

Related tags

Miscellaneous swift-sample-distributed-actors-transport

Overview

swift-sample-distributed-actors-transport

Sample application and ActorTransport, associated with distributed actor language evolution proposal.

Running the sample app

Download the latest toolchain from main branch, or a built one from a specific PR. (Alternatively swift-PR-39087-1111-osx.tar.gz, if still available, is a fine toolchain to use for this sample app.)
Move it to Library/Developer/Toolchains/ and point the TOOLCHAIN env variable at it:

export TOOLCHAIN=/Library/Developer/Toolchains/swift-PR-39061-1098.xctoolchain

To run the sample app, use the following command:

cd SampleApp
DYLD_LIBRARY_PATH=$TOOLCHAIN/usr/lib/swift/macosx $TOOLCHAIN/usr/bin/swift run FishyActorsDemo

all necessary flags to build this pre-release feature are already enabled as unsafe flags in Package.swift.

If you wanted to perform the invocation manually, it would look something like this:

export TOOLCHAIN=/Library/Developer/Toolchains/swift-PR-39087-1109.xctoolchain
DYLD_LIBRARY_PATH=$TOOLCHAIN/usr/lib/swift/macosx $TOOLCHAIN/usr/bin/swift run FishyActorsDemo

setting the DYLD_LIBRARY_PATH is important, so don't forget it.

Sample output

The sample is a chat room application. It creates a few "nodes" and starts distributed actors on them.

There are two kinds of actors, a ChatRoom and Chatters. A single node, representing a cloud component, hosts the chat room. And a few other nodes host chatters. Note that chatters can be on the same or on different nodes.

As the application runs, chatters join the remote ChatRoom and say hello there.

The chat room logs whenever a chatter joins the room, or sends a message:

// chat room logs
[:8001/ChatRoom@130A3D1B-...] Chatter [:9003/Chatter@0A2F138C-...] joined this chat room about: 'Cute Capybaras'
[:8001/ChatRoom@130A3D1B-...] Chatter [:9002/Chatter@8152F16D-...] joined this chat room about: 'Cute Capybaras'
[:8001/ChatRoom@130A3D1B-...] Chatter [:9003/Chatter@4F3970DE-...] joined this chat room about: 'Cute Capybaras'
[:8001/ChatRoom@130A3D1B-...] Forwarding message from [:9002/Chatter@8152F16D-...] to 2 other chatters...
[:8001/ChatRoom@130A3D1B-...] Forwarding message from [:9003/Chatter@4F3970DE-...] to 2 other chatters...
[:8001/ChatRoom@130A3D1B-...] Forwarding message from [:9003/Chatter@0A2F138C-...] to 2 other chatters...
[:8001/ChatRoom@130A3D1B-...] Forwarding message from [:9002/Chatter@8152F16D-...] to 2 other chatters...
[:8001/ChatRoom@130A3D1B-...] Forwarding message from [:9003/Chatter@4F3970DE-...] to 2 other chatters...

The chat room sends a "Welcome ..." message to a joining chatter, and forwards all other chat messages sent to the room to the chatter itself. A chatters logs look like this:

// first chatter
[:9002/Chatter@8152F16D-...] Welcome to the 'Cute Capybaras' chat room! (chatters: 2)
[:9002/Chatter@8152F16D-...] Chatter [:9003/Chatter@0A2F138C-...] joined [:8001/ChatRoom@130A3D1B-...] (total known members in room 2 (including self))
[:9002/Chatter@8152F16D-...]] :9003/Chatter@4F3970DE-... wrote: Welcome [:9003/Chatter@0A2F138C-...]!
[:9002/Chatter@8152F16D-...]] :9003/Chatter@0A2F138C-... wrote: Long time no see [:9002/Chatter@8152F16D-...]!
[:9002/Chatter@8152F16D-...] Chatter [:9003/Chatter@4F3970DE-...] joined [:8001/ChatRoom@130A3D1B-...] (total known members in room 3 (including self))
[:9002/Chatter@8152F16D-...]] :9003/Chatter@4F3970DE-... wrote: Hi there,  [:9002/Chatter@8152F16D-...]!

Notice that the simplified ID printout contains the port number of the node the chatter is running on. In this example, the chatroom is running on port 8001 while the chatter is on 9002. Other chatters may be on the same or on different "nodes" which are represented by actor transport instances.

This sample is a distributed application created from just a single process, but all the "nodes" communicate through networking with eachother. The same application could be launched on different physical hosts (and then would have different IP addresses), this is what location transparency of distributed actors enables us to do.

Experimental flags

This project showcases EXPERIMENTAL language features, and in order to access them the -enable-experimental-distributed flag must be set.

The project is pre-configured with a few experimental flags that are necessary to enable distributed actors, these are configured in each target's swiftSettings:

      .target(
          name: "FishyActorTransport",
          dependencies: [
            ...
          ],
          swiftSettings: [
            .unsafeFlags([
              "-Xfrontend", "-enable-experimental-distributed",
              "-Xfrontend", "-validate-tbd-against-ir=none",
              "-Xfrontend", "-disable-availability-checking", // availability does not matter since _Distributed is not part of the SDK at this point
            ])
          ]),

SwiftPM Plugin

Distributed actor transports are expected to ship with an associated SwiftPM plugin that takes care of source generating the necessary "glue" between distributed functions and the transport runtime.

Plugins are run automatically when the project is build, and therefore add no hassle to working with distributed actors.

Verbose mode

It is possible to force the plugin to run in --verbose mode by setting the VERBOSE environment variable, like this:

VERBOSE=true DYLD_LIBRARY_PATH=$TOOLCHAIN/usr/lib/swift/macosx $TOOLCHAIN/usr/bin/swift run FishyActorsDemo

Analyze: /Users/ktoso/code/fishy-actor-transport/SampleApp/Sources/FishyActorsDemo/_PrettyDemoLogger.swift
Analyze: /Users/ktoso/code/fishy-actor-transport/SampleApp/Sources/FishyActorsDemo/Actors.swift
  Detected distributed actor: ChatRoom
    Detected distributed func: join
    Detected distributed func: message
    Detected distributed func: leave
  Detected distributed actor: Chatter
    Detected distributed func: join
    Detected distributed func: chatterJoined
    Detected distributed func: chatRoomMessage
Analyze: /Users/ktoso/code/fishy-actor-transport/SampleApp/Sources/FishyActorsDemo/main.swift
Generate extensions...
WARNING: This is only a *mock* sample plugin implementation, real functions won't be generated!
  Generate 'FishyActorTransport' extensions for 'distributed actor ChatRoom' -> file:///Users/ktoso/code/fishy-actor-transport/SampleApp/.build/plugins/outputs/sampleapp/FishyActorsDemo/FishyActorTransportPlugin/GeneratedFishyActors_1.swift
  Generate 'FishyActorTransport' extensions for 'distributed actor Chatter' -> file:///Users/ktoso/code/fishy-actor-transport/SampleApp/.build/plugins/outputs/sampleapp/FishyActorsDemo/FishyActorTransportPlugin/GeneratedFishyActors_1.swift

SSL/TLS Add-in for BlueSocket using Secure Transport and OpenSSL

BlueSSLService SSL/TLS Add-in framework for BlueSocket in Swift using the Swift Package Manager. Works on supported Apple platforms (using Secure Tran

87 Nov 15, 2022

A Distributed Value Store in Swift.

Impeller is a Distributed Value Store (DVS) written in Swift. It was inspired by successful Distributed Version Control Systems (DVCSes) like Git and

1 Jun 17, 2020

Hyperledger Sawtooth is an enterprise solution for building, deploying, and running distributed ledgers (also called blockchains).

Hyperledger Sawtooth SDK Hyperledger Sawtooth is an enterprise solution for building, deploying, and running distributed ledgers (also called blockcha

1 Oct 29, 2021

Swift Actors Introduction

Swift-Actors-Introduction Swift 5.5~ 並行処理におけるデータ整合やその他の不具合を防ぐための仕組み。 https://doc

0 Jan 3, 2022

Fast iOS app to browse and search movies, tv, actors, credits

14 Dec 30, 2022

A utility that reminds your iPhone app's users to review the app written in pure Swift.

SwiftRater SwiftRater is a class that you can drop into any iPhone app that will help remind your users to review your app on the App Store/in your ap

289 Dec 12, 2022

This is a Review posting app that let user find interesting places near them

ColorMatchTabs Inspired by this project on Dribbble Also, read how it was done in our blog Installation CocoaPods pod 'ColorMatchTabs' Carthage github

1.4k Dec 5, 2022

In-app design review tool to inspect measurements, attributes, and animations.

Hyperion Hyperion - In App Design Review Tool What is it? Hyperion is a hidden plugin drawer that can easily be integrated into any app. The drawer si

2k Dec 27, 2022

Easy BMI calculator to review optionals, segues and structs

BMI Calculator Our Goal The goal of this tutorial is to learn more about Optionals, solidify your understanding of the MVC design pattern and to intro

0 Oct 24, 2021

A framework to provide logic designed to prompt users at the ideal moment for a review of your app/software

ReviewKit ReviewKit is a Swift package/framework that provides logic designed to prompt users at the ideal moment for a review of your app. At a basic

25 Jun 7, 2022

Appirater - A utility that reminds your iPhone app's users to review the app.

Introduction Appirater is a class that you can drop into any iPhone app (iOS 4.0 or later) that will help remind your users to review your app on the

4.7k Jan 7, 2023

Appstore-Review-Guidelines - A curated list of guideline which has to be taken care before submitting your application to Appstore.

Appstore Review Guidelines The App Review Guidelines provide rules and examples across a range of topics, including user interface design, functionali

14 Dec 16, 2022

Comments

Restructure project to test SourceGen code generation
I was working on adding source generation but found out it was already contributed in the previous PR, which is pretty cool because now anyone can more easily experiment with their own distributed actors. Since I was already working on this I thought I would at least contribute:

a restructuring of the project to make Analysis and SourceGen testable

adjust SourceGen to not depend on a file URL, returning the generated code instead as an array of buckets (as a String), so that tests don't have to generate files and read them back

main.swift now does the writing of the buckets generated by SourceGen into files by itself

add a test for SourceGen

adjust test and SourceGen to generate a more consistent formatting of the generated code

In order to disturb the project as little as possible I restructured the project this way:

create a target and a library product by the name of "FishyActorsCore"

move Analysis and SourceGen into the new module

make the important methods from Analysis and SourceGen public

I am fine with adjusting the PR if there is a more preferable restructuring of the project to make it more testable.

Note: I know this is meant as "just" a small example project, but I think making it more real and functional is a good way to demonstrate the idea and allow people to more easily experiment with their own ideas.
opened by odmir 5
update to shipped language feature (remove codegen, experimental things)

Swift 5.7 includes distributed actors now, and we no longer need to do any of the experimental tricks, or source generation in order to showcase the feature.

This implementation is using official released toolchains and is pretty similar to what was presented in https://developer.apple.com/videos/play/wwdc2022/110356/ and previously in this sample repo. I.e. we still use http client and don't really do anything smart, but the focus is about showing the "shape" of an implementation :-)

opened by ktoso 1

Distributed actors transport example, for feature review

Related tags

Overview

swift-sample-distributed-actors-transport

Running the sample app

Sample output

Experimental flags

SwiftPM Plugin

Verbose mode

You might also like...

SSL/TLS Add-in for BlueSocket using Secure Transport and OpenSSL

A Distributed Value Store in Swift.

Hyperledger Sawtooth is an enterprise solution for building, deploying, and running distributed ledgers (also called blockchains).

Swift Actors Introduction

Fast iOS app to browse and search movies, tv, actors, credits

A utility that reminds your iPhone app's users to review the app written in pure Swift.

This is a Review posting app that let user find interesting places near them

In-app design review tool to inspect measurements, attributes, and animations.

Easy BMI calculator to review optionals, segues and structs

A framework to provide logic designed to prompt users at the ideal moment for a review of your app/software

Appirater - A utility that reminds your iPhone app's users to review the app.

Appstore-Review-Guidelines - A curated list of guideline which has to be taken care before submitting your application to Appstore.

A utility application to capture and review search results from Swift Package Index.

A modern utility that reminds your iOS app's users to review the app in a non-invasive way.

NintendoSwitch-BezierPath-Example - Nintendo Switch Bezier Path Example

Assignment 2 - A fully functional example in the CardinalKit-Example directory

AudioPlayer is syntax and feature sugar over AVPlayer. It plays your audio files (local & remote).

Instagram-like photo browser and a camera feature with a few line of code in Swift.

A TextView that provides easy to use tagging feature for Mention or Hashtag

Comments

Restructure project to test SourceGen code generation

update to shipped language feature (remove codegen, experimental things)

Owner

Apple

Modular iOS with Uber needle & tuist example

Example project for the DeDuplicatingEntity Protocol

React Native Todo List example app which uses Redux for managing app state

tvOS example app, shows upcoming movies

Example how to make, update and end Live Activity. With Dynamic Island and Lock Screen.

An example implementation of using a native iOS Notification Service Extension (to display images in remote push notification) in Titanium.

Example of a Flutter app in the status bar.

Review page interaction - handy and pretty way to ask for review.

Review page interaction - handy and pretty way to ask for review

SSL/TLS Add-in for BlueSocket using Secure Transport and OpenSSL