🚚 rename 'global' to 'publicApi' when it makes more sense

DataDog · Jan 6, 2021 · 6db1bca · 6db1bca
1 parent c03dad4
commit 6db1bca
Show file tree

Hide file tree

Showing 11 changed files with 100 additions and 100 deletions.
diff --git a/packages/core/src/boot/init.ts b/packages/core/src/boot/init.ts
@@ -2,8 +2,8 @@ import { areCookiesAuthorized, CookieOptions } from '../browser/cookie'
 import { buildConfiguration, UserConfiguration } from '../domain/configuration'
 import { setDebugMode, startInternalMonitoring } from '../domain/internalMonitoring'
 
-export function makeGlobal<T>(stub: T): T & { onReady(callback: () => void): void } {
-  const global = {
+export function makePublicApi<T>(stub: T): T & { onReady(callback: () => void): void } {
+  const publicApi = {
     ...stub,
 
     // This API method is intentionally not monitored, since the only thing executed is the
@@ -16,14 +16,14 @@ export function makeGlobal<T>(stub: T): T & { onReady(callback: () => void): voi
 
   // Add an "hidden" property to set debug mode. We define it that way to hide it
   // as much as possible but of course it's not a real protection.
-  Object.defineProperty(global, '_setDebug', {
+  Object.defineProperty(publicApi, '_setDebug', {
     get() {
       return setDebugMode
     },
     enumerable: false,
   })
 
-  return global
+  return publicApi
 }
 
 export function defineGlobal<Global, Name extends keyof Global>(global: Global, name: Name, api: Global[Name]) {

diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -6,7 +6,7 @@ export {
   BuildMode,
   Datacenter,
   defineGlobal,
-  makeGlobal,
+  makePublicApi,
   commonInit,
   checkCookiesAuthorized,
   checkIsNotLocalFile,

diff --git a/packages/logs/src/boot/logs.entry.spec.ts b/packages/logs/src/boot/logs.entry.spec.ts
@@ -1,7 +1,7 @@
 import { Context, monitor, ONE_SECOND } from '@datadog/browser-core'
 
 import { HandlerType, LogsMessage, StatusType } from '../domain/logger'
-import { LogsGlobal, makeLogsGlobal, StartLogs } from './logs.entry'
+import { LogsPublicApi, makeLogsPublicApi, StartLogs } from './logs.entry'
 
 const DEFAULT_INIT_CONFIGURATION = { clientToken: 'xxx' }
 
@@ -28,17 +28,17 @@ describe('logs entry', () => {
     startLogsGetGlobalContext = undefined
   })
 
-  it('should set global with init', () => {
-    const LOGS = makeLogsGlobal(startLogs)
+  it('should define the public API with init', () => {
+    const LOGS = makeLogsPublicApi(startLogs)
     expect(!!LOGS).toEqual(true)
     expect(!!LOGS.init).toEqual(true)
   })
 
   describe('configuration validation', () => {
-    let LOGS: LogsGlobal
+    let LOGS: LogsPublicApi
 
     beforeEach(() => {
-      LOGS = makeLogsGlobal(startLogs)
+      LOGS = makeLogsPublicApi(startLogs)
     })
 
     it('init should log an error with no public api key', () => {
@@ -123,10 +123,10 @@ describe('logs entry', () => {
   })
 
   describe('pre-init API usages', () => {
-    let LOGS: LogsGlobal
+    let LOGS: LogsPublicApi
 
     beforeEach(() => {
-      LOGS = makeLogsGlobal(startLogs)
+      LOGS = makeLogsPublicApi(startLogs)
       jasmine.clock().install()
       jasmine.clock().mockDate()
     })
@@ -196,10 +196,10 @@ describe('logs entry', () => {
   })
 
   describe('post-init API usages', () => {
-    let LOGS: LogsGlobal
+    let LOGS: LogsPublicApi
 
     beforeEach(() => {
-      LOGS = makeLogsGlobal(startLogs)
+      LOGS = makeLogsPublicApi(startLogs)
       LOGS.init(DEFAULT_INIT_CONFIGURATION)
     })
 

diff --git a/packages/logs/src/boot/logs.entry.ts b/packages/logs/src/boot/logs.entry.ts
@@ -7,7 +7,7 @@ import {
   defineGlobal,
   getGlobalObject,
   isPercentage,
-  makeGlobal,
+  makePublicApi,
   monitor,
   UserConfiguration,
 } from '@datadog/browser-core'
@@ -26,18 +26,18 @@ export interface LoggerConfiguration {
   context?: object
 }
 
-export type LogsGlobal = ReturnType<typeof makeLogsGlobal>
+export type LogsPublicApi = ReturnType<typeof makeLogsPublicApi>
 
-export const datadogLogs = makeLogsGlobal(startLogs)
+export const datadogLogs = makeLogsPublicApi(startLogs)
 
 interface BrowserWindow extends Window {
-  DD_LOGS?: LogsGlobal
+  DD_LOGS?: LogsPublicApi
 }
 defineGlobal(getGlobalObject<BrowserWindow>(), 'DD_LOGS', datadogLogs)
 
 export type StartLogs = typeof startLogs
 
-export function makeLogsGlobal(startLogsImpl: StartLogs) {
+export function makeLogsPublicApi(startLogsImpl: StartLogs) {
   let isAlreadyInitialized = false
 
   const globalContextManager = createContextManager()
@@ -49,7 +49,7 @@ export function makeLogsGlobal(startLogsImpl: StartLogs) {
   }
   const logger = new Logger(sendLog)
 
-  return makeGlobal({
+  return makePublicApi({
     logger,
 
     init: monitor((userConfiguration: LogsUserConfiguration) => {

diff --git a/packages/logs/src/index.ts b/packages/logs/src/index.ts
@@ -1,3 +1,3 @@
 export { Logger, LogsMessage, StatusType, HandlerType } from './domain/logger'
-export { LogsUserConfiguration, LoggerConfiguration, LogsGlobal, datadogLogs } from './boot/logs.entry'
+export { LogsUserConfiguration, LoggerConfiguration, LogsPublicApi as LogsGlobal, datadogLogs } from './boot/logs.entry'
 export { LogsEvent } from './logsEvent.types'
diff --git a/packages/rum-core/src/boot/rum.ts b/packages/rum-core/src/boot/rum.ts
@@ -16,7 +16,7 @@ import { CommonContext } from '../rawRumEvent.types'
 import { startRumBatch } from '../transport/batch'
 
 import { buildEnv } from './buildEnv'
-import { RumUserConfiguration } from './rum.entry'
+import { RumUserConfiguration } from './rumPublicApi'
 
 export function startRum(userConfiguration: RumUserConfiguration, getCommonContext: () => CommonContext) {
   const lifeCycle = new LifeCycle()