leopardd / url-shortener-bundle
Symfony Bundle to generate and redirect short url
Installs: 307
Dependents: 0
Suggesters: 0
Security: 0
Stars: 4
Watchers: 2
Forks: 2
Open Issues: 1
Type:symfony-bundle
Requires
- php: ~5.6|~7.0
- doctrine/doctrine-bundle: ^1.6
- doctrine/orm: ^2.5
- hashids/hashids: ^2.0
- jms/serializer-bundle: ^1.3
- symfony/framework-bundle: ~2.6|~3.0
Requires (Dev)
- phpspec/phpspec: ^3.1
- sensio/generator-bundle: ^3.0
- squizlabs/php_codesniffer: ^2.8
- symfony/phpunit-bridge: ^3.0
This package is not auto-updated.
Last update: 2024-11-10 03:25:53 UTC
README
Getting started
1. Install
$ composer require leopardd/url-shortener-bundle
2. Register bundle
<?php
// app/AppKernel.php
public function registerBundles()
{
$bundles = [
// ...
new Leopardd\Bundle\UrlShortenerBundle\LeoparddUrlShortenerBundle(),
];
// ...
}
3. (optional) Setup parameter
// config.yml
leopardd_url_shortener:
hashids:
salt: new salt
min_length: 10
alphabet: abcdefghijklmnopqrstuvwxyz1234567890
4. Update database schema
$ php app/console doctrine:schema:update --force
Folder structure
Controller
DependencyInjection
Entity..................represent table structure
Event
Exception
Factory.................create Entity instance
Repository..............all interaction with database
Resources
Service.................contain business logic
Feature & Update & Note
- Example project: leopardd/bitly
- Support PHP 5.6, 7.0
- Message queue
- Caching (e.g. Redis)
- Scaling
- Separate host/db/table/id
- Docker swarm setup
- what happened when ID reach maximum of MySQL
- Many databases
- Random bulk generate URL for test
- Case-sensitive
- Remove trailing before processing
- Change naming
EncodeServicetoProcessService - Test
EventDispatcher - Using Symfony\Component\Validator as a service + JMS to validate data
- Implement FriendsOfSymfony/FOSRestBundle
- Properties
- Custom code
- Hits
- Expiry date
- Validate url
- Is url
- Remove trailing slash
- No more than 255 character
- Research
- Ph3nol/UrlShortenerBundle
- mremi/UrlShortenerBundle
- gomeeki/url-shortener-bundle](https://github.com/gomeeki/url-shortener-bundle/)
- Test
- phpspec
- PHP CodeSniffer
Algorithm
Get "short-url" process
- Insert "long-url" into database then return
row-id - Encode
row-idthen save it
Redirect "short-url" process
- Decode incoming "short-url" then we get
row-id - Return item in that
row-id
Reason behind "row-id" approach
Short url: produce shortened version of url
- Generate: produce a shortened version of the URL submitted
- Lookup: when the shortened version is called, look up this reference in database then return it
And the challenge is
- Lookup time
- Allow very very large number of unique ids and at the same time
- Keep the ID length as small as possible
- ID should be sort of user friendly and possibly a memorable (if possible)
- Scale with multiple instances (Sharding)
- What happens when ID reach the maximum value e.g. (if the length is 7 containing [A-Z, a-z, 0-9], we can serve 62^7 (~35k billion) urls)
- Replication, database can be crashed by many problems, how to replicate instances, recover fast ?, keep read / write consistent ?
In this bundle, we will focus on point 1. How we can reduce loop-up time.
Table stucture
id: number
code: shortened version of long url
url: long url
Attempt 1
- Generate: random id
- Lookup: simple loop up (O(n))
Attempt 2
- Generate: hash function from long url
- Lookup: simple loop up (O(n))
Attempt 3
- Generate: hash function from long url
- Lookup: bloom filters
Attempt 4
- Generate: hash function from record id
- Lookup: decoding (O(1))
So, In this project decide to using "Attemp 4" by using Hashids for hash function (Hashids will generate unique code from difference id)
Reference && Tool
- Inspired by gomeeki/url-shortener-bundle
- Hashids
- RegExr