diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 478e5ad16..835407b41 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -29,10 +29,10 @@ jobs: uses: actions/setup-node@v4 with: node-version: ${{ matrix.node-version }} - cache: 'pnpm' + cache: 'yarn' env: DATABASE_TYPE: ${{ matrix.db-type }} - - run: npm install --global pnpm - - run: pnpm install - - run: pnpm test - - run: pnpm build + - run: npm install --global yarn + - run: yarn install + - run: yarn test + - run: yarn build diff --git a/.gitignore b/.gitignore index 9cf14dd6a..70a1e1931 100644 --- a/.gitignore +++ b/.gitignore @@ -4,7 +4,6 @@ node_modules .pnp .pnp.js -.pnpm-store # testing /coverage diff --git a/README.md b/README.md index fcbe856f1..cf84d7624 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ A detailed getting started guide can be found at [umami.is/docs](https://umami.i ```bash git clone https://github.com/umami-software/umami.git cd umami -pnpm install +npm install ``` ### Configure Umami @@ -64,7 +64,7 @@ mysql://username:mypassword@localhost:3306/mydb ### Build the Application ```bash -pnpm run build +npm run build ``` _The build step will create tables in your database if you are installing for the first time. It will also create a login user with username **admin** and password **umami**._ @@ -72,7 +72,7 @@ _The build step will create tables in your database if you are installing for th ### Start the Application ```bash -pnpm run start +npm run start ``` _By default, this will launch the application on `http://localhost:3000`. You will need to either [proxy](https://docs.nginx.com/nginx/admin-guide/web-server/reverse-proxy/) requests from your web server or change the [port](https://nextjs.org/docs/api-reference/cli#production) to serve the application directly._ @@ -107,8 +107,8 @@ To get the latest features, simply do a pull, install any new dependencies, and ```bash git pull -pnpm install -pnpm run build +npm install +npm run build ``` To update the Docker image, simply pull the new images and rebuild: diff --git a/src/lib/constants.ts b/src/lib/constants.ts index 7c710326f..7ac1d2abe 100644 --- a/src/lib/constants.ts +++ b/src/lib/constants.ts @@ -154,12 +154,12 @@ export const KAFKA_TOPIC = { export const ROLES = { admin: 'admin', - teamManager: 'team-manager', - teamMember: 'team-member', - teamOwner: 'team-owner', - teamViewOnly: 'team-view-only', user: 'user', viewOnly: 'view-only', + teamOwner: 'team-owner', + teamManager: 'team-manager', + teamMember: 'team-member', + teamViewOnly: 'team-view-only', } as const; export const PERMISSIONS = { @@ -267,7 +267,7 @@ export const URL_LENGTH = 500; export const PAGE_TITLE_LENGTH = 500; export const EVENT_NAME_LENGTH = 50; -export const UTM_PARAMS = ['utm_campaign', 'utm_content', 'utm_medium', 'utm_source', 'utm_term']; +export const UTM_PARAMS = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content']; export const DESKTOP_OS = [ 'BeOS', @@ -305,8 +305,8 @@ export const OS_NAMES = { export const BROWSERS = { android: 'Android', aol: 'AOL', - bb10: 'BlackBerry 10', beaker: 'Beaker', + bb10: 'BlackBerry 10', chrome: 'Chrome', 'chromium-webview': 'Chrome (webview)', crios: 'Chrome (iOS)', @@ -328,256 +328,366 @@ export const BROWSERS = { phantomjs: 'PhantomJS', safari: 'Safari', samsung: 'Samsung', - searchbot: 'Searchbot', silk: 'Silk', + searchbot: 'Searchbot', yandexbrowser: 'Yandex', }; export const IP_ADDRESS_HEADERS = [ 'cf-connecting-ip', + 'x-client-ip', + 'x-forwarded-for', 'do-connecting-ip', 'fastly-client-ip', - 'forwarded', 'true-client-ip', - 'x-appengine-user-ip', - 'x-client-ip', + 'x-real-ip', 'x-cluster-client-ip', 'x-forwarded', - 'x-forwarded-for', - 'x-real-ip', + 'forwarded', + 'x-appengine-user-ip', ]; export const SOCIAL_DOMAINS = [ - 'bsky.app', 'facebook.com', 'fb.com', - 'ig.com', 'instagram.com', - 'linkedin.', - 'news.ycombinator.com', - 'pinterest.', - 'reddit.', - 'snapchat.', - 't.co', - 'threads.net', - 'tiktok.', + 'ig.com', 'twitter.com', + 't.co', 'x.com', + 'linkedin.', + 'tiktok.', + 'reddit.', + 'threads.net', + 'bsky.app', + 'news.ycombinator.com', + 'snapchat.', + 'pinterest.', ]; export const SEARCH_DOMAINS = [ - 'baidu.com', - 'bing.com', - 'chatgpt.com', - 'duckduckgo.com', - 'ecosia.org', 'google.', + 'bing.com', 'msn.com', - 'perplexity.ai', + 'duckduckgo.com', 'search.brave.com', 'yandex.', + 'baidu.com', + 'ecosia.org', + 'chatgpt.com', + 'perplexity.ai', ]; export const SHOPPING_DOMAINS = [ - 'alibaba.com', - 'aliexpress.com', 'amazon.', - 'bestbuy.com', 'ebay.com', - 'etsy.com', - 'newegg.com', - 'target.com', 'walmart.com', + 'alibab.com', + 'aliexpress.com', + 'etsy.com', + 'bestbuy.com', + 'target.com', + 'newegg.com', ]; export const EMAIL_DOMAINS = [ 'gmail.', - 'hotmail.', 'mail.yahoo.', 'outlook.', - 'proton.me', + 'hotmail.', 'protonmail.', + 'proton.me', ]; -export const VIDEO_DOMAINS = ['twitch.', 'youtube.']; +export const VIDEO_DOMAINS = ['youtube.', 'twitch.']; export const PAID_AD_PARAMS = [ - 'ad_id=', - 'aid=', - 'dclid=', - 'epik=', - 'fbclid=', + 'utm_source=google', 'gclid=', - 'li_fat_id=', + 'fbclid=', 'msclkid=', - 'ob_click_id=', - 'pc_id=', - 'rdt_cid=', - 'scid=', - 'ttclid=', + 'dclid=', 'twclid=', + 'li_fat_id=', + 'epik=', + 'ttclid=', + 'scid=', + 'aid=', + 'pc_id=', + 'ad_id=', + 'rdt_cid=', + 'ob_click_id=', 'utm_medium=cpc', 'utm_medium=paid', 'utm_medium=paid_social', - 'utm_source=google', ]; export const GROUPED_DOMAINS = [ - { name: 'Bing', domain: 'bing.com', match: 'bing.' }, - { name: 'Brave', domain: 'brave.com', match: 'brave.' }, - { name: 'ChatGPT', domain: 'chatgpt.com', match: 'chatgpt.' }, - { name: 'DuckDuckGo', domain: 'duckduckgo.com', match: 'duckduckgo.' }, + { name: 'Google', domain: 'google.com', match: 'google.' }, { name: 'Facebook', domain: 'facebook.com', match: 'facebook.' }, + { name: 'Reddit', domain: 'reddit.com', match: 'reddit.' }, + { name: 'LinkedIn', domain: 'linkedin.com', match: 'linkedin.' }, { name: 'GitHub', domain: 'github.com', match: 'github.' }, { name: 'Hacker News', domain: 'news.ycombinator.com', match: 'news.ycombinator.com' }, - { name: 'Instagram', domain: 'instagram.com', match: ['instagram.', 'ig.com'] }, - { name: 'LinkedIn', domain: 'linkedin.com', match: 'linkedin.' }, - { name: 'Pinterest', domain: 'pinterest.com', match: 'pinterest.' }, - { name: 'Reddit', domain: 'reddit.com', match: 'reddit.' }, - { name: 'Snapchat', domain: 'snapchat.com', match: 'snapchat.' }, + { name: 'Bing', domain: 'bing.com', match: 'bing.' }, + { name: 'Brave', domain: 'brave.com', match: 'brave.' }, + { name: 'DuckDuckGo', domain: 'duckduckgo.com', match: 'duckduckgo.' }, { name: 'Twitter', domain: 'twitter.com', match: ['twitter.', 't.co', 'x.com'] }, - { name: 'Google', domain: 'google.com', match: 'google.' }, + { name: 'Instagram', domain: 'instagram.com', match: ['instagram.', 'ig.com'] }, + { name: 'Snapchat', domain: 'snapchat.com', match: 'snapchat.' }, + { name: 'Pinterest', domain: 'pinterest.com', match: 'pinterest.' }, + { name: 'ChatGPT', domain: 'chatgpt.com', match: 'chatgpt.' }, ]; export const MAP_FILE = '/datamaps.world.json'; export const ISO_COUNTRIES = { - ANT: 'AN', - ARE: 'AE', - BLM: 'BL', - CHE: 'CH', - ESH: 'EH', - ESP: 'ES', - FSM: 'FM', - GBR: 'GB', + AFG: 'AF', + ALA: 'AX', + ALB: 'AL', + DZA: 'DZ', + ASM: 'AS', + AND: 'AD', + AGO: 'AO', + AIA: 'AI', + ATA: 'AQ', + ATG: 'AG', + ARG: 'AR', + ARM: 'AM', + ABW: 'AW', + AUS: 'AU', + AUT: 'AT', + AZE: 'AZ', + BHS: 'BS', + BHR: 'BH', + BGD: 'BD', + BRB: 'BB', + BLR: 'BY', + BEL: 'BE', + BLZ: 'BZ', + BEN: 'BJ', + BMU: 'BM', + BTN: 'BT', + BOL: 'BO', + BIH: 'BA', + BWA: 'BW', + BVT: 'BV', + BRA: 'BR', + VGB: 'VG', + IOT: 'IO', + BRN: 'BN', + BGR: 'BG', + BFA: 'BF', + BDI: 'BI', + KHM: 'KH', + CMR: 'CM', + CAN: 'CA', + CPV: 'CV', + CYM: 'KY', + CAF: 'CF', + TCD: 'TD', + CHL: 'CL', + CHN: 'CN', + HKG: 'HK', + MAC: 'MO', + CXR: 'CX', + CCK: 'CC', + COL: 'CO', + COM: 'KM', + COG: 'CG', + COD: 'CD', + COK: 'CK', + CRI: 'CR', + CIV: 'CI', + HRV: 'HR', + CUB: 'CU', + CYP: 'CY', + CZE: 'CZ', + DNK: 'DK', + DJI: 'DJ', + DMA: 'DM', + DOM: 'DO', + ECU: 'EC', + EGY: 'EG', + SLV: 'SV', + GNQ: 'GQ', + ERI: 'ER', + EST: 'EE', + ETH: 'ET', + FLK: 'FK', + FRO: 'FO', + FJI: 'FJ', + FIN: 'FI', + FRA: 'FR', + GUF: 'GF', + PYF: 'PF', + ATF: 'TF', + GAB: 'GA', + GMB: 'GM', + GEO: 'GE', + DEU: 'DE', + GHA: 'GH', + GIB: 'GI', + GRC: 'GR', + GRL: 'GL', + GRD: 'GD', + GLP: 'GP', + GUM: 'GU', + GTM: 'GT', + GGY: 'GG', + GIN: 'GN', + GNB: 'GW', + GUY: 'GY', + HTI: 'HT', + HMD: 'HM', + VAT: 'VA', + HND: 'HN', + HUN: 'HU', + ISL: 'IS', + IND: 'IN', + IDN: 'ID', + IRN: 'IR', + IRQ: 'IQ', + IRL: 'IE', + IMN: 'IM', + ISR: 'IL', + ITA: 'IT', JAM: 'JM', + JPN: 'JP', JEY: 'JE', JOR: 'JO', - JPN: 'JP', KAZ: 'KZ', KEN: 'KE', - KGZ: 'KG', KIR: 'KI', - KNA: 'KN', + PRK: 'KP', KOR: 'KR', KWT: 'KW', + KGZ: 'KG', LAO: 'LA', + LVA: 'LV', LBN: 'LB', + LSO: 'LS', LBR: 'LR', LBY: 'LY', - LCA: 'LC', LIE: 'LI', - LKA: 'LK', - LSO: 'LS', LTU: 'LT', LUX: 'LU', - LVA: 'LV', - MAF: 'MF', - MAR: 'MA', - MCO: 'MC', - MDA: 'MD', - MDG: 'MG', - MDV: 'MV', - MEX: 'MX', - MHL: 'MH', MKD: 'MK', - MLI: 'ML', - MLT: 'MT', - MMR: 'MM', - MNE: 'ME', - MNG: 'MN', - MNP: 'MP', - MOZ: 'MZ', - MRT: 'MR', - MSR: 'MS', - MTQ: 'MQ', - MUS: 'MU', + MDG: 'MG', MWI: 'MW', MYS: 'MY', + MDV: 'MV', + MLI: 'ML', + MLT: 'MT', + MHL: 'MH', + MTQ: 'MQ', + MRT: 'MR', + MUS: 'MU', MYT: 'YT', + MEX: 'MX', + FSM: 'FM', + MDA: 'MD', + MCO: 'MC', + MNG: 'MN', + MNE: 'ME', + MSR: 'MS', + MAR: 'MA', + MOZ: 'MZ', + MMR: 'MM', NAM: 'NA', - NCL: 'NC', - NER: 'NE', - NFK: 'NF', - NGA: 'NG', - NIC: 'NI', - NIU: 'NU', - NLD: 'NL', - NOR: 'NO', - NPL: 'NP', NRU: 'NR', + NPL: 'NP', + NLD: 'NL', + ANT: 'AN', + NCL: 'NC', NZL: 'NZ', + NIC: 'NI', + NER: 'NE', + NGA: 'NG', + NIU: 'NU', + NFK: 'NF', + MNP: 'MP', + NOR: 'NO', OMN: 'OM', PAK: 'PK', + PLW: 'PW', + PSE: 'PS', PAN: 'PA', - PCN: 'PN', + PNG: 'PG', + PRY: 'PY', PER: 'PE', PHL: 'PH', - PLW: 'PW', - PNG: 'PG', + PCN: 'PN', POL: 'PL', - PRI: 'PR', - PRK: 'KP', PRT: 'PT', - PRY: 'PY', - PSE: 'PS', + PRI: 'PR', QAT: 'QA', REU: 'RE', ROU: 'RO', RUS: 'RU', RWA: 'RW', - SAU: 'SA', - SDN: 'SD', - SEN: 'SN', - SGP: 'SG', - SGS: 'GS', + BLM: 'BL', SHN: 'SH', - SJM: 'SJ', - SLB: 'SB', - SLE: 'SL', - SMR: 'SM', - SOM: 'SO', + KNA: 'KN', + LCA: 'LC', + MAF: 'MF', SPM: 'PM', - SRB: 'RS', - SSD: 'SS', + VCT: 'VC', + WSM: 'WS', + SMR: 'SM', STP: 'ST', - SUR: 'SR', + SAU: 'SA', + SEN: 'SN', + SRB: 'RS', + SYC: 'SC', + SLE: 'SL', + SGP: 'SG', SVK: 'SK', SVN: 'SI', - SWE: 'SE', + SLB: 'SB', + SOM: 'SO', + ZAF: 'ZA', + SGS: 'GS', + SSD: 'SS', + ESP: 'ES', + LKA: 'LK', + SDN: 'SD', + SUR: 'SR', + SJM: 'SJ', SWZ: 'SZ', - SYC: 'SC', + SWE: 'SE', + CHE: 'CH', SYR: 'SY', - TCA: 'TC', - TGO: 'TG', - THA: 'TH', + TWN: 'TW', TJK: 'TJ', - TKL: 'TK', - TKM: 'TM', + TZA: 'TZ', + THA: 'TH', TLS: 'TL', + TGO: 'TG', + TKL: 'TK', TON: 'TO', TTO: 'TT', TUN: 'TN', TUR: 'TR', + TKM: 'TM', + TCA: 'TC', TUV: 'TV', - TWN: 'TW', - TZA: 'TZ', UGA: 'UG', UKR: 'UA', + ARE: 'AE', + GBR: 'GB', + USA: 'US', UMI: 'UM', URY: 'UY', - USA: 'US', UZB: 'UZ', - VCT: 'VC', - VEN: 'VE', - VIR: 'VI', - VNM: 'VN', VUT: 'VU', + VEN: 'VE', + VNM: 'VN', + VIR: 'VI', WLF: 'WF', - WSM: 'WS', - XKX: 'XK', + ESH: 'EH', YEM: 'YE', - ZAF: 'ZA', ZMB: 'ZM', ZWE: 'ZW', + XKX: 'XK', }; diff --git a/src/lib/detect.ts b/src/lib/detect.ts index ee9d2603c..2e6a067dd 100644 --- a/src/lib/detect.ts +++ b/src/lib/detect.ts @@ -15,27 +15,6 @@ import { safeDecodeURIComponent } from '@/lib/url'; const MAXMIND = 'maxmind'; -const PROVIDER_HEADERS = [ - // Cloudflare headers - { - countryHeader: 'cf-ipcountry', - regionHeader: 'cf-region-code', - cityHeader: 'cf-ipcity', - }, - // Vercel headers - { - countryHeader: 'x-vercel-ip-country', - regionHeader: 'x-vercel-ip-country-region', - cityHeader: 'x-vercel-ip-city', - }, - // CloudFront headers - { - countryHeader: 'cloudfront-viewer-country', - regionHeader: 'cloudfront-viewer-country-region', - cityHeader: 'cloudfront-viewer-city', - }, -]; - export function getIpAddress(headers: Headers) { const customHeader = process.env.CLIENT_IP_HEADER; @@ -115,19 +94,30 @@ export async function getLocation(ip: string = '', headers: Headers, hasPayloadI } if (!hasPayloadIP && !process.env.SKIP_LOCATION_HEADERS) { - for (const provider of PROVIDER_HEADERS) { - const countryHeader = headers.get(provider.countryHeader); - if (countryHeader) { - const country = decodeHeader(countryHeader); - const region = decodeHeader(headers.get(provider.regionHeader)); - const city = decodeHeader(headers.get(provider.cityHeader)); + // Cloudflare headers + if (headers.get('cf-ipcountry')) { + const country = decodeHeader(headers.get('cf-ipcountry')); + const region = decodeHeader(headers.get('cf-region-code')); + const city = decodeHeader(headers.get('cf-ipcity')); - return { - country, - region: getRegionCode(country, region), - city, - }; - } + return { + country, + region: getRegionCode(country, region), + city, + }; + } + + // Vercel headers + if (headers.get('x-vercel-ip-country')) { + const country = decodeHeader(headers.get('x-vercel-ip-country')); + const region = decodeHeader(headers.get('x-vercel-ip-country-region')); + const city = decodeHeader(headers.get('x-vercel-ip-city')); + + return { + country, + region: getRegionCode(country, region), + city, + }; } }