Merge branch 'master' into signals-sampling

Author: danieljackins

packages/browser/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @segment/analytics-next
 
+## 1.75.0
+
+### Minor Changes
+
+- [#1160](https://github.com/segmentio/analytics-next/pull/1160) [`bedea03b`](https://github.com/segmentio/analytics-next/commit/bedea03bb50e01a7df71461087a9ec340375906d) Thanks [@MichaelGHSeg](https://github.com/MichaelGHSeg)! - Adding apiHost to the readonly data available from Analytics.settings
+
 ## 1.74.0
 
 ### Minor Changes

packages/browser/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@segment/analytics-next",
-  "version": "1.74.0",
+  "version": "1.75.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/segmentio/analytics-next",

packages/browser/src/browser/__tests__/integration.test.ts

@@ -1041,12 +1041,15 @@ describe('public settings api', () => {
       cdnSettings: cdnSettingsMinimal,
     })
 
-    expect(analytics.settings).toEqual({
-      writeKey,
-      cdnSettings: cdnSettingsMinimal,
-      timeout: 300,
-      cdnURL: 'https://cdn.segment.com',
-    })
+    expect(analytics.settings).toEqual(
+      expect.objectContaining({
+        writeKey,
+        cdnSettings: cdnSettingsMinimal,
+        timeout: 300,
+        cdnURL: 'https://cdn.segment.com',
+        apiHost: 'api.segment.io/v1',
+      })
+    )
   })
 
   it('should have a writeKey', async () => {

packages/browser/src/core/analytics/index.ts

@@ -51,6 +51,10 @@ import {
 } from '../storage'
 import { setGlobalAnalytics } from '../../lib/global-analytics-helper'
 import { popPageContext } from '../buffer'
+import {
+  isSegmentPlugin,
+  SegmentIOPluginMetadata,
+} from '../../plugins/segmentio'
 
 const deprecationWarning =
   'This is being deprecated and will be not be available in future releases of Analytics JS'
@@ -81,13 +85,19 @@ export class AnalyticsInstanceSettings {
    */
   readonly cdnSettings: CDNSettings
   readonly cdnURL?: string
+  get apiHost(): string | undefined {
+    return this._getSegmentPluginMetadata?.()?.apiHost
+  }
+  private _getSegmentPluginMetadata?: () => SegmentIOPluginMetadata | undefined
 
   /**
    * Auto-track specific timeout setting for legacy purposes.
    */
   timeout = 300
 
-  constructor(settings: AnalyticsSettings) {
+  constructor(settings: AnalyticsSettings, queue: EventQueue) {
+    this._getSegmentPluginMetadata = () =>
+      queue.plugins.find(isSegmentPlugin)?.metadata
     this.writeKey = settings.writeKey
     this.cdnSettings = settings.cdnSettings ?? {
       integrations: {},
@@ -201,14 +211,15 @@ export class Analytics
     super()
     const cookieOptions = options?.cookie
     const disablePersistance = options?.disableClientPersistence ?? false
-    this.settings = new AnalyticsInstanceSettings(settings)
+
     this.queue =
       queue ??
       createDefaultQueue(
         `${settings.writeKey}:event-queue`,
         options?.retryQueue,
         disablePersistance
       )
+    this.settings = new AnalyticsInstanceSettings(settings, this.queue)
 
     const storageSetting = options?.storage
     this._universalStorage = this.createStore(

packages/browser/src/generated/version.ts

@@ -1,2 +1,2 @@
 // This file is generated.
-export const version = '1.74.0'
+export const version = '1.75.0'

packages/browser/src/plugins/segmentio/index.ts

@@ -50,6 +50,19 @@ function onAlias(analytics: Analytics, json: JSON): JSON {
   return json
 }
 
+export type SegmentIOPluginMetadata = {
+  writeKey: string
+  apiHost: string
+  protocol: string
+}
+export interface SegmentIOPlugin extends Plugin {
+  metadata: SegmentIOPluginMetadata
+}
+
+export const isSegmentPlugin = (plugin: Plugin): plugin is SegmentIOPlugin => {
+  return plugin.name === 'Segment.io'
+}
+
 export function segmentio(
   analytics: Analytics,
   settings?: SegmentioSettings,
@@ -129,7 +142,12 @@ export function segmentio(
       })
   }
 
-  const segmentio: Plugin = {
+  const segmentio: SegmentIOPlugin = {
+    metadata: {
+      writeKey,
+      apiHost,
+      protocol,
+    },
     name: 'Segment.io',
     type: 'destination',
     version: '0.1.0',

packages/consent/consent-tools/README.md

@@ -93,7 +93,8 @@ withCMP(window.analytics).load('<MY_WRITE_KEY')
 
 ## Wrapper Examples
 
-- [OneTrust](../consent-wrapper-onetrust) (beta)
+- [OneTrust](../consent-wrapper-onetrust) 
+- [TrustArc](https://github.com/trustarc/trustarc-segment-wrapper)
 
 ## Settings / Options / Configuration
 

packages/signals/signals-example/CHANGELOG.md

@@ -4,6 +4,14 @@
 
 ### Patch Changes
 
+- Updated dependencies [[`c8ce6144`](https://github.com/segmentio/analytics-next/commit/c8ce6144b31bddfc66961e979d5648fb66e102e5), [`29d17003`](https://github.com/segmentio/analytics-next/commit/29d1700303d0384fbd01edee9e9ff231f35de9ef), [`bedea03b`](https://github.com/segmentio/analytics-next/commit/bedea03bb50e01a7df71461087a9ec340375906d)]:
+  - @segment/analytics-signals@1.4.0
+  - @segment/analytics-next@1.75.0
+
+## null
+
+### Patch Changes
+
 - Updated dependencies [[`3f58366b`](https://github.com/segmentio/analytics-next/commit/3f58366b0e01aa723d9d3bbb9fe8549d3082eb8e), [`29e856f9`](https://github.com/segmentio/analytics-next/commit/29e856f9f36088a0dc625014ebda8e09fc3b621e), [`c45d445b`](https://github.com/segmentio/analytics-next/commit/c45d445beb1b1d5b03738557720720d05e9c08a3)]:
   - @segment/analytics-next@1.74.0
   - @segment/analytics-signals@1.3.0

packages/signals/signals-example/src/components/ComplexForm.tsx

@@ -2,11 +2,24 @@ import React, { FormEventHandler, useState } from 'react'
 
 const ComplexForm = () => {
   const [inputField, setInputField] = useState('')
+  const [expectFormError, setExpectFormError] = useState(false)
   const [selectField, setSelectField] = useState('')
 
+  const statusCode: number = React.useMemo(() => {
+    try {
+      // Change the response status code via the text input field
+      const val = parseInt(inputField, 10)
+      return val >= 100 && val <= 511 ? val : 400
+    } catch (err) {
+      return 400
+    }
+  }, [inputField])
+
   const handleSubmit: FormEventHandler<HTMLFormElement> = (event) => {
     event.preventDefault()
+
     const formData = {
+      status: expectFormError ? statusCode : 200,
       inputField,
       selectField,
     }
@@ -33,16 +46,16 @@ const ComplexForm = () => {
       <button data-custom-attr="some-custom-attribute">Example Button</button>
       <form onSubmit={handleSubmit}>
         <div>
-          <label htmlFor="ex-input">Input Field:</label>
+          <label htmlFor="ex-input-text">Input some text:</label>
           <input
-            id="ex-input"
+            id="ex-input-text"
             type="text"
             value={inputField}
             onChange={(e) => setInputField(e.target.value)}
           />
         </div>
         <div>
-          <label htmlFor="ex-select">Select Field:</label>
+          <label htmlFor="ex-select">Select an option:</label>
           <select
             id="ex-select"
             value={selectField}
@@ -55,7 +68,16 @@ const ComplexForm = () => {
             <option value="Option 2">Option 2</option>
           </select>
         </div>
-        <button type="submit">Submit</button>
+        <div>
+          <label htmlFor="ex-checkbox">{`Force submit network status: ${statusCode}`}</label>
+          <input
+            id="ex-checkbox"
+            type="checkbox"
+            checked={expectFormError}
+            onChange={(e) => setExpectFormError(e.target.checked)}
+          />
+        </div>
+        <button type="submit">Submit via network req</button>
       </form>
       <button>
         <div>

packages/signals/signals-example/src/styles.css

@@ -40,3 +40,7 @@ nav a {
 nav a:hover {
   color: #007bff;
 }
+
+form div {
+  display: inline-block;
+}