commit

Author: ugran

browser/.eslintrc.js

@@ -0,0 +1,9 @@
+/** @type { import('eslint').Linter.Config } */
+module.exports = {
+  ignorePatterns: ['e2e-tests', 'qa', '/*.tmp.*/'],
+  extends: ['../../.eslintrc'],
+  env: {
+    node: true, // TODO: change to false when node is abstracted out
+    browser: true,
+  },
+}

browser/.lintstagedrc.js

@@ -0,0 +1 @@
+module.exports = require("@internal/config").lintStagedConfig

browser/ARCHITECTURE.md

@@ -0,0 +1,51 @@
+# Architecture
+
+## Codebases
+
+analytics-next is comprised of two different codebases:
+
+- [analytics-next](https://github.com/segmentio/analytics-next): All core functionality of AJSN
+- [integrations](https://github.com/segmentio/analytics.js-integrations): All existing legacy client side destinations
+
+This diagram outlines the relationship between these two codebases (cloudfront being where the integrations are hosted):
+![Architecture](.github/architecture.png?raw=true)
+
+## Core
+
+Some of the bigger core modules are briefly outlined here -
+
+- arguments-resolver: Responsible for reshuffling arguments in event calls
+- context: Responsible for building context objects for different events
+- emitter: Responsible for emitting events and adding listeners for them
+- events: Responsible for building the different Segment events (track, page, etc), and normalizing those events
+- logger: Responsible for building and flushing the logs that will be carried around in an events context object
+- queue: The heart of AJSN, the queue is responsible for managing events which will be delivered to plugins and destinations, and handles things such as retries, timeouts, and delivery reliability
+- user: Responsible for all of the logic built around an analytics user
+
+The general end to end flow of analytics-next core is as follows:
+
+1. Legacy settings and destinations are loaded from the segment CDN
+2. The Analytics object is instantiated with the loaded settings, and sets up things such as new/existing users and an event queue.
+3. Events are built and queued when a user makes a Segment call (ie. analytics.track())
+4. The event is dispatched, goes through all enabled plugins, and is finally sent through the segment.io plugin to get the data into Segment
+
+## Everything is a Plugin
+
+When developing against analytics-next you will likely be writing plugins, which can augment AJSN functionality and enrich data. Plugins are isolated chunks which you can build, test, version, and deploy independently of the rest of the codebase. Extensions are bounded by AJSN which handles things such as observability, retries, and error management.
+
+Plugins can be of two different priorities:
+
+- Critical: AJSN should expect this plugin to be loaded before starting event delivery
+- Non-critical: AJSN can start event delivery before this plugin has finished loading
+
+and can be of five different types:
+
+- Before: Pleguns that need to be run before any other plugins are run. An example of this would be validating events before passing them along to other plugins.
+- After: Plugins that need to run after all other plugins have run. An example of this is the segment.io integration, which will wait for destinations to succeed or fail so that it can send its observability metrics.
+- Destination: Destinations to send the event to (ie. legacy destinations). Does not modify the event and failure does not halt execution.
+- Enrichment: Modifies an event, failure here could halt the event pipeline.
+- Utility: Plugins that change AJSN functionality and don't fall into the other categories.
+
+## Observability
+
+Every event and plugin has a context object, which contains both metrics and logs that were collected throughout their lifetime. Logs can be used for debugging, and the metrics will be included when the event is sent to Segment.

browser/CHANGELOG.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright © 2021 Segment
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

browser/LICENSE.MD

@@ -0,0 +1,85 @@
+BIN := ./node_modules/.bin
+yarn_run := yarn run -T browser
+
+help: ## Lists all available make tasks and some short documentation about them
+	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-24s\033[0m %s\n", $$1, $$2}'
+.PHONY: help
+
+
+## Basic repo maintenance
+
+# Installs npm dependencies
+node_modules:
+	yarn install --immutable
+	@touch $@
+
+build-browser: build # build dependencies
+	$(yarn_run) umd --no-stats
+.PHONY: build-browser
+
+build: ## Builds libraries in prod mode, and all dependencies
+	yarn run -T browser . build
+.PHONY: build
+
+clean: ## Clean the build directory
+	rm -rf dist generated
+.PHONY: clean
+
+## Test Commands
+
+tdd: node_modules ## Runs unit tests in watch mode
+	$(yarn_run) test --watch
+.PHONY: tdd
+
+test-unit: node_modules ## Runs unit tests
+	$(yarn_run) test
+.PHONY: test-unit
+
+test-coverage: node_modules ## Runs unit tests with coverage
+	$(yarn_run) test --coverage --forceExit
+.PHONY: test-coverage
+
+test-qa: build-browser ## Runs all QA tests in a single command
+	$(yarn_run) test --runTestsByPath qa/__tests__/*.test.ts --testPathIgnorePatterns qa/__tests__/destinations.test.ts --reporters="default" --reporters="<rootDir>/qa/lib/jest-reporter.js" ${args}
+.PHONY: test-coverage
+
+test-qa-destinations: build-browser ## Runs Destination QA tests. options. DESTINATION=amplitude DEBUG=true
+	$(yarn_run) test --forceExit --runTestsByPath qa/__tests__/destinations.test.ts --reporters="default" --reporters="<rootDir>/qa/lib/jest-reporter.js" ${args}
+.PHONY: test-coverage
+
+test-integration: build ## Runs all integration tests in a single command
+	$(yarn_run) test --forceExit --runTestsByPath e2e-tests/**/*.test.ts ${args}
+.PHONY: test-coverage
+
+test-perf: build ## Runs all integration tests in a single command
+	$(yarn_run) test --forceExit --runTestsByPath e2e-tests/performance/*.test.ts ${args}
+.PHONY: test-coverage
+
+lint: node_modules ## Lints the source code
+	$(yarn_run) lint
+.PHONY: lint
+
+ci:
+	bash ./scripts/ci.sh
+.PHONY: ci
+
+handshake:
+	@echo "📡  Establishing Remote connection"
+	@robo --config ~/dev/src/github.com/segmentio/robofiles/development/robo.yml prod.ssh echo "✅ Connected"
+.PHONY: handshake
+
+rebuild-sources-prod: handshake ## Rebuilds all sources that are using ajs-next
+	@aws-okta exec prod-privileged -- ./scripts/ajs-sources.js
+.PHONY: rebuild-sources-prod
+
+rebuild-sources-stage: # Rebuilds all sources that are using ajs-next in stage
+	@robo --config ~/dev/src/github.com/segmentio/robofiles/development/robo.yml rebuild-all-stage
+.PHONY: rebuild-sources-stage
+
+analyze:
+	NODE_ENV=production $(BIN)/webpack --profile --json > stats.json && $(BIN)/webpack-bundle-analyzer --port 4200 stats.json
+.PHONY: analyze
+
+dev: ## Starts a dev server that is ready for development
+	yarn workspace @playground/next-playground run dev
+.PHONY: dev