Péhápkaři v Pecce: A refactoring Journey – From Legacy to Laravel – Christopher Fuchs – 14. 11.

ready2order.com© 2018 ready2order GmbH.
From Legacy To Laravel
A Refactoring Journey
Christopher Fuchs, Co-Founder & CTO

- Web- and cloudbased POS solution for catering, retail and service
- Start of development in 2012
- Founded ready2order GmbH in 2015 at 25 customers
- Currently 60+ employees
- 7000+ customers in Austria, Germany, Switzerland
- Vision: All-In-One Solution for SMBs
Who are we?
© 2018 ready2order GmbH. Alle Rechte vorbehalten. 1 | X

- POS
- Stock & ingredients management
- Accounting (BMD, DATEV, SAP, …)
- Printer integrations
- Payment terminal integrations
- Time tracking
- Coupons, discounts & happy hours
- Price levels
- RKSV signature
- Bar- & QR-Code integrations
- Highly configurable
- ….
- Hybrid apps for
- iOS
- Android
- Windows
- Mac
- Offline mode
- Public API
- Live statistics
- Supplier management
- User & role management
- Detailed reports
- Offers & Delivery bills
- ...
Features

1 | Meet Mr. Legacy

The good parts first…

…and the bad parts
„Just do it like it‘s 1999“
- 200,000 lines of PHP code
- Mixture of PHP, JavaScript, CSS, HTML in one file
- Business, view and backend logic in one file
- Business logic redundancies
- No separation of concerns
- No single entry point
- Bad folder structure
- Messy interdependencies everywhere
- Big, fat models
- No CI, templating, jobs, queues
- class.ready2order.php is used in almost every file
- Impossible to follow for new developers

What was the code like?
„Just do it like it‘s 1999“

Some things needs to change…

2 | The journey

- „WTF should we do“ (June – August 2017)
- „Let‘s do a rewrite“ (September 2017)
- „No this won‘t work...let‘s refactor!“ (2 days later)
- „DIY-framework...why not Laravel? Let‘s do it!“ (Begin of October 2017)
What did we do?
ready2order GmbH
Refactor Rewritevs

Legacy Code

üNamespaced legacy code
üBuild and manage assets with grunt
üRestructured project structure
üImplemented fallback proxy controller
üRemoved globals & global states
üRewrote bash scripts to symfony console commands
üRemoved existing eloquent 5.2 from legacy code
üMigrated routes
üImplemented queue system
üGO LIVE - Begin of November 2017
2 people spent approx. 400 hours each within 4 weeks
What did we do to go live?

- Refactor step-by-step, file-by-file, route-by-route
- Single point of entry
- No feature freeze
- Clean project structure
- Fast way into production
- Well-known framework – less scary for new developers
What benefits did we get?

3 | Status quo

- 70% of business logic code already refactored
- Use full power of Laravel
- Abstraction layers
- Authentication & Authorization
- Database migrations
- Broadcasting
- Caching & Mutexes
- Logging
- Custom app-specific Error Handlers (PublicExceptionInterface)
- Event system
- Implemented custom SessionManager on top of Laravel’s auth
- Controller – SessionService - Service – Repository -pattern
What happened since November 2017?

- Router
- Resolves route to controller’s method
- Authentication
- Controller
- Map request data to business-logic-domain object (Model or DataClass)
- Perform route-specific authorization checks with policy
- Call business logic method via SessionXxyyzzService or return Blade-view
- SessionUserService
- Perform business-logic specific authorization checks
- Collect session data & call business logic method in XxyyzzService
- UserService
- Run business logic operation which gets all necessary information from method arguments (No access to session data
allowed!)
- UserRepo
- Extends autogenerated AbstractXxyyzzRepo
- CRUD-methods to access database-layer via models
- User (Model)
- AbstractionLayer for database tables
Code structure & layers Example: User

- Administration
- POS
- Public API
Creating a user

Back then…

Router
routes/apps/api/users.php

Controller
app/Http/Controllers/Api/V1/User/ApiUserController.php

CreateUserMutationRequest
app/Http/Controllers/Api/V1/User/Request/CreateUserMutationRequest.php

SessionUserService
src/R2/Modules/User/SessionUserService.php

UserService
src/R2/Modules/User/UserService.php

(Abstract)UserRepo
src/R2/Modules/User/UserRepo.php extends autogenerated
src/R2/Db/Repo/Base/AbstractUserRepo.php

User(Model)
src/R2/Legacy/Database/Model/User.php extends autogenerated
src/R2/Legacy/Database/Model/Base/AbstractUser.php

What about documentation?

- Autogenerate API documentation to OpenAPI-spec with
zircote/swagger-php
Codegeneration FTW

- GraphQL + React
- Code Generation
- Base models
- Base repositories
- Test-factories
- GraphQL type and query auto-generation
from spec-files
- Enhanced Gitlab CI
- phpcsfixer for coding style
- Static Code Analysis with phpstan
- Custom phpstan rules which detect
common code-style violations to speed-up
code reviews
- (Semi)Continous deployment
- Swagger for OpenAPI documentation
generation
- Many utility commands to make dev’s
lifes easier
- Database migrations with percona
- Distributed maintenance mode
- Automated release integration with jira
- ICU Intl-message-format
- docker-compose setup
- Upcoming
- kubernetes/GKE as long-term
replacement for AWS
What else is going on?

We killed the monster! – 28.8.2018
class.ready2order.php

- Grow development team
- Scale infrastructure
- Implement sharding and necessary tooling
- Improve UX
- API First with GraphQL
- Scale by extracting services
- Scalable logging, monitoring and reporting infrastructure
- Security-first with regular internal and external penetrations tests
- Train our chaos monkey
Roadmap

- „think – prototype – discuss – repeat“
- Rewrites are mostly doomed to fail as a lot of knowledge get lost
- Refactoring should result in rewrite
- Clean up project first, then separate business logic
What did we learn?

- Laravel IDE Helper (barryvdh/laravel-ide-helper)
- Phpstan (phpstan/phpstan)
- Code Sniffer (squizlabs/php_codesniffer)
- phpdbg (krakjoe/phpdbg)
- paratest (brianium/paratest)
- swagger/php
We are hiring
ready2order.com/jobs
Things to know
© 2018e ready2order GmbH. Alle Rechte vorbehalten. 31 | X

Refactor
+
- One code base, team, deployment
- Fast go-to-live
- Reuse existing code
- Step-by-step migration
-
- Hard to remove bad patterns
- Hard to move to framework
- Requires code insights
Rewrite
+
- Clean implementation
- Easy onboarding for new devs
- No architectural burdens
-
- Very large code base
- Long project doomed to fail
- Maintain two separate system
- Feature freeze
What to do?
„think – prototyp – discuss“

What to consider?
„think – prototyp – discuss“
BATTLE TIME
Refactor
vs
Rewrite
PHP Go / Java / ?
REST GraphQL
Fullstack Application API only

Péhápkaři v Pecce: A refactoring Journey – From Legacy to Laravel – Christopher Fuchs – 14. 11.

More Related Content

Similar to Péhápkaři v Pecce: A refactoring Journey – From Legacy to Laravel – Christopher Fuchs – 14. 11. (20)

More from PeckaDesign.cz (20)

Recently uploaded (20)

Péhápkaři v Pecce: A refactoring Journey – From Legacy to Laravel – Christopher Fuchs – 14. 11.