SpotifyX Architectural Review
•Download as PPTX, PDF•
1 like•322 views
A framework for the family of application like Spotify
Recommended
Recommended
More Related Content
What's hot
What's hot (20)
Similar to SpotifyX Architectural Review
Similar to SpotifyX Architectural Review (20)
More from Morteza Zakeri
More from Morteza Zakeri (20)
Recently uploaded
Recently uploaded (20)
SpotifyX Architectural Review
- 1. SpotifyX: A Framework for the family of applications like Spotify By: Morteza Zakeri and Arman Sanahmadi Software Architectures Course Instructor: Dr. Mehrdad Ashtiani Iran University of Science and Technology School of Computer Engineering Fall 2018
- 2. 20 Agenda • Introduction • Feature list • Architectural Blueprints • Physical view (Deployment diagram) • Development view (Component diagram) • Logical view (Class diagram) • References October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures 2
- 3. 20 Spotify: Music for everyone! October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures 3 Introduction Features Architectural Blueprints Physical view Development view Logical view
- 4. 20 Spotify: Features October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures 4 Introduction Features Architectural Blueprints Physical view Development view Logical view Profile Search Streaming Payment Friendship Advertisement Playlist Recommendation
- 5. 20 Features list 1. Streaming 2. Search 3. Recommendation 4. Playlist 5. Friendship and Following 6. User management (Profile) • Signup • Login • Logout • Profile info 7. Payment • Premium account October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures 5 Introduction Features Architectural Blueprints Physical view Development view Logical view
- 6. 20 Three main feature Is it part of the essence of the system? What the “heck” does it mean? How the “heck” do I do it? Streaming Yes Search Yes Recommendation No Playlist No Friendship and Following No User management (Profile) Yes Payment Yes October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures 6 Introduction Features Architectural Blueprints Physical view Development view Logical view
- 7. 20 4+1 architectural view model October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures 7 Philippe Kruchten, 1995 Introduction Features Architectural Blueprints Physical view Development view Logical view
- 8. 20 Physical view (Deployment diagram) October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures 8 Introduction Features Architectural Blueprints Physical view Development view Logical view Client ... API Gateway Request DMZ 1 (Microservices) Media Streaming Media Search Microservice Microservice Media Recommend Microservice Media Storage Management (HDFS) DMZ 2 (Other Services) Authentication Profile Data Provider ... Business Logic Layer KubernetesConsul Low-level Back-end (Third Parties) Configurations (Git Repository) Neo4j Cassandra Data Model Layer Response Firewall Clients Servers Friendship and Follower
- 9. 20 Development view (Component diagram) October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures 9 Introduction Features Architectural Blueprints Physical view Development view Logical view <<component>> MediaSerach <<component>> APIGateway <<component>> Client <<component>> CassandraDriver <<component>> HDFSDriver <<component>> MediaStreaming <<component>> MediaRecomendation <<component>> SearchEngine <<component>> Model <<component>> Autentication <<component>> FreindshipAndFollower <<component>> Profile <<component>> Neo4jDriver
- 10. 20 Logical view (Class diagram) By Arman Sanahmadi • Today: 1. Media streaming microservice 2. Media search microservice 3. Media recommendation microservice • Next Presentation: 4. Profile 5. Payment 6. Playlist 7. Friendship October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures 10 Introduction Features Architectural Blueprints Physical view Development view Logical view
- 11. 20 Development view (Component diagram) October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures 11 Introduction Features Architectural Blueprints Physical view Development view Logical view <<component>> MediaSerach <<component>> APIGateway <<component>> Client <<component>> CassandraDriver <<component>> HDFSDriver <<component>> MediaStreaming <<component>> MediaRecomendation <<component>> SearchEngine <<component>> Model <<component>> Autentication <<component>> FreindshipAndFollower <<component>> Profile <<component>> Neo4jDriver
- 12. 20 Media streaming microservice October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures 12 Introduction Features Architectural Blueprints Physical view Development view Logical view <<Abstract>> ServiceAPI -baseURL: string +ServiceAPI(): void -conn : ServiceConnection +setBaseURL(string) : void -initializer(): ServiceConnetion +geyBaseURL(): string #requestHandler(IRequest req): IResponse ServiceConnection - socket : Socket +ServiceConnection() : void +CreateService(string) : void #requestSerializer(IRequest) : byte[] #sendRequest(bbyte []) : byte[] #responseParser(byte[]) : IResponse StreamMusicAPI +streamMusic() : IResponse +pause() : IResponse +stop() : IResponse StreamSetting -qulity: Quality -id : string<<Interface>> IAudioStreaming startStreaming(Stream Setting) : byte[] pauseStreaming() : void StreamHQ startStreaming(String address) : byte[] +pauseStreaming() : void StreamLQ startStreaming(String address) : byte[] +pauseStreaming() : void SteamMQ startStreaming(String address) : byte[] +pauseStreaming() : void <<Interface>> IResponse +getResponseContent() : byte[] +setResponseContent(byte [] ) : void <<Interface>> IRequest +getRequestContent() : byte[] +setRequestContent (byte[]) : void StreamResponse +getBuffer() : byte[] +getProgress() : int +resume() : boolean +pause() : boolean +getChannel() : Channel StreamRequest +getchannel() : Channel +setChannel(Channel) : void +setChannel(Channel) : void -address : string getQuality() : enum -AudioStreaming setAddress(string) : void +setQuality(enum) : void +getAddress() : string +getID() : string +setID(string) : void <<Enumeration>> Quality +High +Medium +Low DBHandler +getConnection() : Connection
- 13. 20 Media search microservice October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures 13 Introduction Features Architectural Blueprints Physical view Development view Logical view <<Abstract>> HttpServlet -baseURL: string +ServiceAPI(): void -conn : ServiceConnection +setBaseURL(string) : void -initializer(): ServiceConnetion +geyBaseURL(): string ServiceConnection - socket : Socket +ServiceConnection() : void +CreateService(string) : void #requestSerializer(IRequest) : byte[] #sendRequest(bbyte []) : byte[] #responseParser(byte[]) : IResponse SearchAPI +search(iReq: IRequest, iRes: IResponse): void +getUserHistory(iReq: IRequest, iRes: IResponse): void SearchEngine -resultList: List<SearchResult> <<Interface>> IResponse +getResponseContent() : byte[] +setResponseContent(byte [] ) : void <<Interface>> IRequest +getRequestContent() : byte[] +setRequestContent (byte[]) : void RESTResponse +getResponseBody():JSONParser +getResponseCode() : int +getResponseContent(): byte[] +getHeaders() : Headers[] RESTRequest +getHeaders() : Headers[] +getRequestContent(): byte[] -saveHistory(): void +find(tag: string, userID: string): List<SearchResult> +retrieveHistory(userID: string): List<SearchResult> SearchResult -id: string -name: string -type: Type 1 * +getRequestBody():JSONParser +setRequestBody(body: JSONParser):void +setRequestContent(content: byte[]): void +setHeaders(headers: Headers[]) : void+setResponseBody(body: JSONParser):void +setHeaders(headers: Headers[]) : void +setResponseContent(content: byte[]): void +setResponseCode(code: int): void +seters and getters() DBHandler +getConnection() : Connection #processRequest(iReq: IRequest, iRes: IResponse): void <<Enumeration>> Type +type1 +type2 +type3
- 14. 20 Media recommendation microservice October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures 14 Introduction Features Architectural Blueprints Physical view Development view Logical view <<Abstract>> HttpServlet -baseURL: string +ServiceAPI(): void -conn: ServiceConnection +setBaseURL(s: string) : void -initializer(): ServiceConnetion +geyBaseURL(): string ServiceConnection - socket : Socket +ServiceConnection(): void +CreateService(s: string): void #requestSerializer(iReq: IRequest): byte[] #sendRequest(b: byte []): byte[] #responseParser(b: byte[]): IResponse RecommendationAPI +findRecom(iReq: IRequest, iRes: IResponse): void <<Inteface>> RecommendationAlgorithm +produceRecommendation(userID: String): List<SearchResult> Algorithm1 Algorithm2 Algorithm3 <<Interface>> IResponse +getResponseContent() : byte[] +setResponseContent(b: byte []) : void <<Interface>> IRequest +getRequestContent() : byte[] +setRequestContent (b: byte[]) : void RESTResponse +getResponseBody():JSONParser +getResponseCode() : int +getResponseContent(): byte[] +getHeaders() : Headers[] RESTRequest +getHeaders() : Headers[] +getRequestContent(): byte[] +getRequestBody():JSONParser +setRequestBody(body: JSONParser):void +setRequestContent(content: byte[]): void +setHeaders(headers: Headers[]) : void+setResponseBody(body: JSONParser):void +setHeaders(headers: Headers[]) : void +setResponseContent(content: byte[]): void +setResponseCode(code: int): void +ProduceRecommendation(userID: String):List<SearchResult> +ProduceRecommendation(userID: String): List<SearchResult> +getHistory(userID: String): List<SearchResult> SearchResult -id: string -name: string -type: Type +seters and getters() -results : List<searchResult> -results : List<searchResult> -results : List<searchResult> +getHistory(userID: String): List<SearchResult> +getHistory(userID: String):List<SearchResult> +getHistory(userID: String): List<SearchResult> <<Enumeration>> Type +type1 +type2 +type3 DBHandler +getConnection(): Connection +ProduceRecommendation(userID: String): List<SearchResult> #processRequest(iReq: IRequest, iRes: IResponse): void -recomAlg: RecommendationAlgorithm
- 15. 20 Model October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures 15 Introduction Features Architectural Blueprints Physical view Development view Logical view User -username: String -password: String -email: String -isPremium: Boolean -playlists: List<Playlist> -friends:List<User> -following: List<Artist> Artist -biography : String -albums: List<Album> -followers: List<User> +seters(args-to-set): void +getters(): Property +seters(args-to-set): void +getters(): Property <<Interface>><<Interface>> IModel +toJSON(): String +fromJSON(s: String): void Album -id: long -title: String -publishDate: Date -tracks: List<Music> -description: String +seters(args-to-set): void +getters(): Property -artist:Artist Music -id: long -title: String -publishDate: Date -geners: List<Gener> -isSingleTrack: boolean -lyric: Map<Date, String> +seters(args-to-set): void +getters(): Property -artist:Artist Playlist -id: long -title: String -createDate: Date -tracks: List<Music> -description: String +seters(args-to-set): void +getters(): Property -length: double -rate: int <<Enumeration>> Gener +Pop +Rock +Rap +... -firstName : String -lastName: String -photo: Picture -firstName : String -lastName: String -aliasName: String -photo: Picture -id: long -id: long 1 * m n 1 * 1 * 1 * 1 * DBHandler +getConnection(): Connection+save():void +read(query: String):IModel
- 16. 20 Accounting October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures 16 Introduction Features Architectural Blueprints Physical view Development view Logical view Transaction -status : TransactionStatus +getStatus():TransactionStatus -date: Date -amount: float -setStatus(): transactionStatus +commit(): bool +rollback(): bool +getDate(): date +getAmount(): float +setAmount(float f): void +setDate(Date d): void <<Enumeration>> TransactionStatus +Done +Pending +Failed Premium -offers: List<Offer> +buyPremium(offer): Transaction -transaction: Transaction +getExpireDate(): Date +getTransaction(): Transaction 1 * Account -user: User +doLogin(): session -permium: Premium -session: Session +doLogout(session): void +getAccountType(): Premium +getSession(): Session <<Interface>> ILogin +doLogin(Stringuser,Stringpass):Session -checkUserExist(String username):boolean GoogleLogin +doLogin(Stringuser,Stringpass):Session -checkUserExist(String username):boolean SpotifyLogin -checkUserExist(username: String):boolean +doLogin(username: String, password: String):Session Session -sessionID: String getinstance(): Session -user: User -LoginType LoginType Offer -id +setterAndGetters() -duration: int -price: double -discount double -memberName 1 * +doSignUp(): Session <<Interface>><<Interface>> IModel +toJSON(): String +fromJSON(s: String) +save():void +read(id: String):IModel DBHandler +getConnection(): Connection <<Enumeration>> LoginType +google +spotify getinstance(User u): Session
- 17. 20 High-level services (Logic) October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures 17 Introduction Features Architectural Blueprints Physical view Development view Logical view <<Abstract>> HttpServlet -baseURL: string +ServiceAPI(): void -conn: ServiceConnection +setBaseURL(s: string) : void -initializer(): ServiceConnetion +geyBaseURL(): string ServiceConnection - socket : Socket +ServiceConnection(): void +CreateService(s: string): void #requestSerializer(iReq: IRequest): byte[] #sendRequest(b: byte []): byte[] #responseParser(b: byte[]): IResponse AuthenticationAPI +Login(iReq: IRequest, iRes: IResponse): void <<Interface>> IResponse +getResponseContent() : byte[] +setResponseContent(b: byte []) : void <<Interface>> IRequest +getRequestContent() : byte[] +setRequestContent (b: byte[]) : void RESTResponse +getResponseBody():JSONParser +getResponseCode() : int +getResponseContent(): byte[] +getHeaders() : Headers[] RESTRequest +getHeaders() : Headers[] +getRequestContent(): byte[] +getRequestBody():JSONParser +setRequestBody(body: JSONParser):void +setRequestContent(content: byte[]): void +setHeaders(headers: Headers[]) : void+setResponseBody(body: JSONParser):void +setHeaders(headers: Headers[]) : void +setResponseContent(content: byte[]): void +setResponseCode(code: int): void +Logout(iReq: IRequest, iRes: IResponse): void +signup(iReq: IRequest, iRes: IResponse): void ProfileManagerAPI +CreatePlayList(iReq: IRequest, iRes: IResponse): void +DeletePlayList(iReq: IRequest, iRes: IResponse): void +RemoveMusicfromPlaylist(iReq: IRequest, iRes: IResponse): void +AddMusicToPlaylist(iReq: IRequest, iRes: IResponse): void +EditPlayList(iReq: IRequest, iRes: IResponse): void +BuyPremium(iReq: IRequest, iRes: IResponse): void +GetPlayLists(iReq: IRequest, iRes: IResponse): void FriendshipAndFollowerAPI +addFriend(iReq: IRequest, iRes: IResponse): void +removeFriend(iReq: IRequest, iRes: IResponse): void +addFollower(iReq: IRequest, iRes: IResponse): void +removeFollower(iReq: IRequest, iRes: IResponse): void +checkIsPremium(iReq: IRequest, iRes: IResponse): void
- 18. 20 Demo Code (in Java) October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures 18 Service model Introduction Features Architectural Blueprints Physical view Development view Logical view
- 19. 20 References [1] P. Kruchten, “The 4+1 view model of architecture,” IEEE Software., vol. 12, no. 6, pp. 42–50, Nov. 1995. [2] Spotify Labs., “architecture,” 2018. [Online]. Available: https://labs.spotify.com/tag/architecture/. [Accessed: 20-Dec-2018]. [3] B.D. McLaughlin, G. Pollice, and D. West, Head first object-oriented analysis and design, O’Reilly Media, 2007. [4] Visual Paradigm, “What is unified modeling language (UML)?,” Visual Paradigm, 2018. [Online]. Available: https://www.visual- paradigm.com/guide/uml-unified-modeling-language/what-is-uml/. [Accessed: 26-Dec-2018]. October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures 19
- 21. 20 4+1 architectural view model October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures +1 Philippe Kruchten, 1995 Backup slides
- 22. 20 Process view (Activity diagram) • To be added October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures +2 Backup slides
- 23. 20 Scenarios (Use cases) • Demo code • Code template (demonstrated by test scenarios) • By Arman Sanahmadi • Using Postman to develop • APIs October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures +3 Backup slides
- 24. 20 Technologies we used • And some other libraries, packages and tools Backup slides October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures +4
- 25. 20 UML diagrams we used October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures +6 Backup slides
- 26. 20 UML diagrams we used October 2018 SpotifyX - Morteza Zakeri and Arman Sanahmadi- Software Architectures +5 Backup slides
Editor's Notes
- SpotifyX: Framework for the family of applications like Spotify By: Morteza Zakeri Nasrabadi and Arman SanAhmadi Software Architectures Course – Winter 2018 Instructor: Dr. Mehrdad Ashtiani School of Computer Engineering Iran University of Science and Technology Final slides
- Outline Agenda Page numbering is activated.
- The three Qs of architecture When you’re trying to figure out if something is architecturally significant, there are three questions you can ask: Is it part of the essence of the system? Is the feature really core to what a system actually is? Think about it this way: can you imagine the system without that feature? If not, then you’ve probably found a feature that is part of the essence of a system. Is it part of the essence of the system? Is the feature really core to what a system actually is? Think about it this way: can you imagine the system without that feature? If not, then you’ve probably found a feature that is part of the essence of a system. How the “heck” do I do it? Another place to focus your attention early on is on features that seem really hard to implement, or are totally new programming tasks for you. If you have no idea how you’re going to tackle a particular problem, you better spend some time up front looking at that feature, so it doesn’t create lots of problems down the road.
- Design is ART! We modified our design many times. Design is a teamwork. Every body has is own ART! This may be the final version, version 5. Not YET? Arman should see it
- Component diagram vs Package diagram.
- Component diagram vs Package diagram.
- Order by most using… Do you agree???
- Thank you for your attention! Framework for the family of applications like Spotify By: Morteza Zakeri See backup slides section for more information. Last edit: 1397 09 26– Monday – presentation day; after presentation. Edit 2: 1397 07 27 Edit 1: 1397 10 05