Angular Application Architecture: npm Packages, Monorepos and Microservices, ngHamburg, March 2018

Slide 1

Slide 1 text

@BASTAcon & @ManfredSteyer Angular Application Architecture: npm Packages, Monorepos and Microservices Manfred Steyer SOFTWAREarchitekt.at

Slide 2

Slide 2 text

@BASTAcon & @ManfredSteyer About me… • Manfred Steyer • SOFTWAREarchitekt.at • Angular Trainings and Consultancy • Google Developer Expert (GDE) Page ▪ 4 Manfred Steyer

Slide 3

Slide 3 text

@ManfredSteyer Questions • How to structure an Angular application? • How to subdivide an Angular application into smaller parts?

Slide 4

Slide 4 text

@ManfredSteyer Contents • Modules • (npm-)Packages • Monorepos • Microservices

Slide 5

Slide 5 text

@ManfredSteyer Modules

Slide 6

Slide 6 text

@ManfredSteyer Typical Module Structure Page ▪ 11 AppModule … … … SharedModule Root Module Feature Modules Shared Module

Slide 7

Slide 7 text

@ManfredSteyer npm Packages

Slide 8

Slide 8 text

@ManfredSteyer Why npm Packages? Reusable Logic Structuring big Applications

Slide 9

Slide 9 text

@ManfredSteyer Structure of an npm Package • /node_modules • your-stuff • package.json

Slide 10

Slide 10 text

@ManfredSteyer Properties in package.json (Selection) name version description entry-point(s) typings dependencies

Slide 11

Slide 11 text

@ManfredSteyer package.json { "dependencies": { "@angular/core": "4.2.0", "@angular/http": "4.2.0" } }

Slide 12

Slide 12 text

@ManfredSteyer package.json { "dependencies": { "@angular/core": "4.2.0", "@angular/http": "4.2.0" } }

Slide 13

Slide 13 text

@ManfredSteyer package.json { "dependencies": { }, "peerDependencies": { "@angular/core": "^4.0.0", "@angular/http": "^4.0.0" } }

Slide 14

Slide 14 text

@ManfredSteyer package.json { "dependencies": { }, "peerDependencies": { "@angular/core": "^4.0.0", "@angular/http": "^4.0.0" }, "devDependencies": { [...] } }

Slide 15

Slide 15 text

@ManfredSteyer Simple Module @NgModule({ imports: [ CommonModule ], declarations: [ DemoComponent ], providers: [ DemoService ], exports: [ DemoComponent ] }) export class DemoModule { }

Slide 16

Slide 16 text

@ManfredSteyer Simple Module @NgModule({ imports: [ CommonModule ], declarations: [ DemoComponent ], providers: [ DemoService ], exports: [ DemoComponent ] }) export class DemoModule { } Problem!

Slide 17

Slide 17 text

@ManfredSteyer Providers are Global! Page ▪ 26 AppModule … … … SharedModule ModuleFromLib Service Service <>

Slide 18

Slide 18 text

@ManfredSteyer Providers are Global! Page ▪ 27 AppModule … … … SharedModule ModuleFromLib Service w/ Services w/o Services <>

Slide 19

Slide 19 text

@ManfredSteyer Simple Module @NgModule({ imports: [ CommonModule ], declarations: [ DemoComponent ], providers: [ /* no services */ ], exports: [ DemoComponent ] }) export class DemoModule { static forRoot(): ModuleWithProviders { return { ngModule: DemoModule, providers: [ DemoService ] } } }

Slide 20

Slide 20 text

@ManfredSteyer Barrels

Slide 21

Slide 21 text

@ManfredSteyer Idea behind Barrels • ES Module: File == Modul • Far too fine-grained for consumers of a lib • Barrel == Façade for those files == Public API

Slide 22

Slide 22 text

@ManfredSteyer index.ts as Barrel export * from './src/demo.service'; export { OtherDemoService } from './src/other-demo.service'; export { DemoModule } from './src/demo.module';

Slide 23

Slide 23 text

@ManfredSteyer Project Start

Slide 24

Slide 24 text

@ManfredSteyer Angular Package Format https://goo.gl/hjt7G3

Slide 25

Slide 25 text

@ManfredSteyer Many Details!

Slide 26

Slide 26 text

@ManfredSteyer ng-packagr

Slide 27

Slide 27 text

@ManfredSteyer Possible Folder Structure Library Barrel Cli-based Playground

Slide 28

Slide 28 text

@ManfredSteyer Possible Folder Structure This gets published For Development

Slide 29

Slide 29 text

@ManfredSteyer Configuration in lib/package.json { […] "ngPackage": { "dest": "../dist/lib", "lib": { "entryFile": "./public_api.ts" } } }

Slide 30

Slide 30 text

@ManfredSteyer Build-Script in /package.json { "scripts": { […] "build:lib": "ng-packagr -p lib/package.json", }, […] }

Slide 31

Slide 31 text

@ManfredSteyer Test and Deployment

Slide 32

Slide 32 text

@ManfredSteyer Local testing • Symbolic Links • Library: npm link • Consumer: npm link library-name

Slide 33

Slide 33 text

@ManfredSteyer Publishing to npm Registry • Increment version in package.json • npm version [patch | minor | major | version] • npm run build • cd ../dist • npm publish --registry http://localhost:4873 • npm install --registry http://localhost:4873

Slide 34

Slide 34 text

@ManfredSteyer Alternatives for setting the Registry • Global: npm set registry http://localhost:4873 • Default: registry.npmjs.org • npm get registry • Project: .npmrc in project root

Slide 35

Slide 35 text

@ManfredSteyer Locale npm-Registry • TFS • Nexus • Artifactory • Verdaccio • Very lightweight • npm i -g verdaccio • Start: verdaccio

Slide 36

Slide 36 text

@ManfredSteyer DEMO LoggerService LoggerConfig <>

Slide 37

Slide 37 text

@ManfredSteyer DEMO LoggerService LoggerConfig LogFormatterService <> DefaultLogFormatter Service

Slide 38

Slide 38 text

@ManfredSteyer Advantages • Distribution • Versioning • Decoupling between lib authors and app authors

Slide 39

Slide 39 text

@ManfredSteyer Disadvantages • Distribution • Versioning • Decoupling between lib authors and app authors ;-)

Slide 40

Slide 40 text

@ManfredSteyer Disadvantages Distribution • Annoying within project • Prevents gritting further libs Versioning • Old versions • Conflicts • How to force devs to use latest version? Decoupling • What if lib authors == app authors?

Slide 41

Slide 41 text

@ManfredSteyer Monorepos

Slide 42

Slide 42 text

@ManfredSteyer Monorepo Structure Define Code Owners for different folders

Slide 43

Slide 43 text

@ManfredSteyer Advantages Everyone uses the latest versions No version conflicts No burden with distributing libs Creating new libs: Adding folder Experience: Successfully used at Google, Facebook, …

Slide 44

Slide 44 text

@ManfredSteyer Two Flavors • Like Workspaces/Solutions in different IDEs Project Monorepo • E. g. used at Google or Facebook Company-wide Monorepo

Slide 45

Slide 45 text

@ManfredSteyer Tooling & Generator https://nrwl.io/nx

Slide 46

Slide 46 text

@ManfredSteyer Usage npm install -g @nrwl/schematics npm install -g @angular/cli create-nx-workspace myworkspace ng generate app myapp ng generate lib mymodule ng serve --app=myapp ng generate component myButton --app=mymodule ng build --app=myapp

Slide 47

Slide 47 text

@ManfredSteyer Further features • Just recompile changed apps/ libs • Restrict which app/ lib can access which other libs

Slide 48

Slide 48 text

@ManfredSteyer Moving back and forth

Slide 49

Slide 49 text

@ManfredSteyer Moving back and forth Npm Registry

Slide 50

Slide 50 text

@ManfredSteyer Alternative Git Repo Git-based Sub-Module (read only or read/write)

Slide 51

Slide 51 text

@ManfredSteyer DEMO

Slide 52

Slide 52 text

@ManfredSteyer Microservices

Slide 53

Slide 53 text

@ManfredSteyer Idea System

Slide 54

Slide 54 text

@ManfredSteyer Idea µService µService µService

Slide 55

Slide 55 text

@ManfredSteyer Folie▪ 71 Pro Contra

Slide 56

Slide 56 text

@ManfredSteyer UI Composition w/ Hyperlinks µService SPA µService SPA µService SPA

Slide 57

Slide 57 text

@ManfredSteyer

Slide 58

Slide 58 text

@ManfredSteyer

Slide 59

Slide 59 text

@ManfredSteyer

Slide 60

Slide 60 text

@ManfredSteyer µService Providing a (SPA-based) Shell µService µService µService Shell

Slide 61

Slide 61 text

@ManfredSteyer Some Options for Shell iframes • Strong Isolation • Straight forward • Overlapping Elements? • Lot's of page requests? Web Components • Standard • Custom Elements • • • Shadow DOM: CSS Isolation • Framework Support? Bootstrapping different SPAs • Similar to Web Components • No Standard

Slide 62

Slide 62 text

@ManfredSteyer Experimental in Angular 6

Slide 63

Slide 63 text

@ManfredSteyer Some General Advice for "Macro-Architecture" Shared state, communication/ navigation b/w apps Hyperlinks Legacy Apps or *very very* strong isolation needed? iframes Need separate Deployment/ mix Technologies Web Components "Majestic Monolith" w/ Libs and Monorepo little much yes no yes no Not best fit when customer facing Fallback: Bootstrap several frameworks/ Spa Micro-Architecture: Mix and match options: • Libs/ npm packages • Monorepo • Web Components

Slide 64

Slide 64 text

@ManfredSteyer How to find the right solution? • You need to know your architectural goal • You need to prioritize them --> Bring them in an order! • One Approach: https://goo.gl/soigHm

Slide 65

Slide 65 text

@ManfredSteyer Blog • A Software Architect's Approach Towards Using Angular (And SPAs In General) For Microservices Aka Microfrontends • A Lightweight And Solid Approach Towards Micro Frontends (Micro Service Clients) With Angular And/Or Other Frameworks • Microservice Clients With Web Components Using Angular Elements: Dreams Of The (Near) Future?

Slide 66

Slide 66 text

@ManfredSteyer Conclusion Packages for Structuring and Reuse Angular Package Format Monorepo Micro Services

Slide 67

Slide 67 text

@ManfredSteyer Contact and Downloads [mail] [email protected] [blog] SOFTWAREarchitekt.at [twitter] ManfredSteyer