Merge branch 'main' into docs/sdk-metrics

.github/workflows/peer-api.yml

@@ -10,7 +10,7 @@ jobs:
   peer-api-check:
     runs-on: ubuntu-latest
     container:
-      image: node:14
+      image: node:18
     steps:
       - name: Checkout
         uses: actions/checkout@v3

api/.commitlintrc.yml

@@ -0,0 +1,29 @@
+extends:
+  - '@commitlint/config-conventional'
+rules:
+  header-max-length: [1, 'always', 72]
+  type-enum:
+  - 2
+  - always
+  - - ci
+    - feat
+    - fix
+    - docs
+    - style
+    - refactor
+    - perf
+    - test
+    - revert
+    - chore
+help: |
+  **Possible types**:
+  `ci`:       Changes to our CI configuration files and scripts (example scopes: Travis, Circle CI, BrowserStack, SauceLabs)
+  `feat`:     Adds a new feature.
+  `fix`:      Solves a bug.
+  `docs`:     Adds or alters documentation. (example scopes: readme, worker, code_of_conduct, contributors)
+  `style`:    Improves formatting, white-space.
+  `refactor`: Rewrites code without feature, performance or bug changes.
+  `perf`:     Improves performance.
+  `test`:     Adds or modifies tests. (example scopes: functionals, unit-tests)
+  `revert`:   Changes that reverting other changes
+  `chore`:    No production code change. Updating grunt tasks etc;

api/.editorconfig

@@ -0,0 +1,11 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true

api/.eslintrc.js

@@ -0,0 +1,69 @@
+module.exports = {
+  plugins: [
+    "@typescript-eslint",
+    "header",
+    "node"
+  ],
+  extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
+  parser: "@typescript-eslint/parser",
+  parserOptions: {
+    "project": "./tsconfig.json"
+  },
+  rules: {
+    "quotes": [2, "single", { "avoidEscape": true }],
+    "@typescript-eslint/no-floating-promises": 2,
+    "@typescript-eslint/no-this-alias": "off",
+    "brace-style": ["error", "1tbs"],
+    "eqeqeq": [
+      "error",
+      "smart"
+    ],
+    "prefer-rest-params": "off",
+    "@typescript-eslint/naming-convention": [
+      "error",
+      {
+        "selector": "memberLike",
+        "modifiers": ["private", "protected"],
+        "format": ["camelCase"],
+        "leadingUnderscore": "require"
+      }
+    ],
+    "no-console": "error",
+    "no-shadow": "off",
+    "@typescript-eslint/no-shadow": ["warn"],
+    "@typescript-eslint/no-unused-vars": ["error", {"argsIgnorePattern": "^_", "args": "after-used"}],
+    "@typescript-eslint/no-inferrable-types": ["error", { ignoreProperties: true }],
+    "@typescript-eslint/no-empty-function": ["off"],
+    "@typescript-eslint/ban-types": ["warn", {
+      "types": {
+        "Function": null,
+      }
+    }],
+    "@typescript-eslint/no-shadow": ["warn"],
+    "arrow-parens": ["error", "as-needed"],
+    "node/no-deprecated-api": ["warn"],
+    "header/header": [2, "block", [{
+      pattern: / \* Copyright The OpenTelemetry Authors[\r\n]+ \*[\r\n]+ \* Licensed under the Apache License, Version 2\.0 \(the \"License\"\);[\r\n]+ \* you may not use this file except in compliance with the License\.[\r\n]+ \* You may obtain a copy of the License at[\r\n]+ \*[\r\n]+ \*      https:\/\/www\.apache\.org\/licenses\/LICENSE-2\.0[\r\n]+ \*[\r\n]+ \* Unless required by applicable law or agreed to in writing, software[\r\n]+ \* distributed under the License is distributed on an \"AS IS\" BASIS,[\r\n]+ \* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied\.[\r\n]+ \* See the License for the specific language governing permissions and[\r\n]+ \* limitations under the License\./gm,
+      template:
+        `\n * Copyright The OpenTelemetry Authors\n *\n * Licensed under the Apache License, Version 2.0 (the "License");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *      https://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an "AS IS" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n `
+    }]]
+  },
+  overrides: [
+    {
+      "files": ["test/**/*.ts"],
+      "rules": {
+        "no-empty": "off",
+        "@typescript-eslint/ban-ts-ignore": "off",
+        "@typescript-eslint/no-empty-function": "off",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-floating-promises": 1,
+        "@typescript-eslint/no-unused-vars": "off",
+        "@typescript-eslint/no-var-requires": "off",
+        "@typescript-eslint/no-shadow": ["off"],
+        "@typescript-eslint/no-floating-promises": ["off"],
+        "@typescript-eslint/no-non-null-assertion": ["off"],
+        "@typescript-eslint/explicit-module-boundary-types": ["off"]
+      }
+    }
+  ]
+};

api/.gitattributes

@@ -0,0 +1,39 @@
+## This .gitattributes file automatically formats the EOL character in certain filetypes within the repository
+
+## Source code
+# JavaScript, TypeScript, c, and h source files
+*.js                    text eol=lf
+*.ts                    text eol=lf
+*.h                     text eol=lf diff=cpp
+*.c                     text eol=lf diff=cpp
+
+# Shell scripts
+*.sh                    text eol=lf
+*.bash                  text eol=lf
+
+# Windows batch and PowerShell scripts
+*.bat                   text eol=crlf
+*.cmd                   text eol=crlf
+*.ps1                   text eol=crlf
+
+##### Other file types #####
+
+## Text files and documentation
+*.txt                   text
+README*                 text
+RELEASING*              text
+CHANGELOG*              text
+CONTRIBUTING*           text
+INSTALL*                text
+LICENSE*                text
+
+## Non-text documentation
+*.html                  text diff=html
+*.pdf                   binary
+*.json                  text eol=lf
+*.rtf                   binary
+
+## Git Properties
+.gitignore              text
+.gitmodules             text
+.gitattributes          text

api/.github/CODEOWNERS

@@ -0,0 +1,15 @@
+#####################################################
+#
+# List of approvers for OpenTelemetry JS SDK
+#
+#####################################################
+#
+# Learn about membership in OpenTelemetry community:
+#  https://github.com/open-telemetry/community/blob/master/community-membership.md
+#
+#
+# Learn about CODEOWNERS file format:
+#  https://help.github.com/en/articles/about-code-owners
+#
+
+* @open-telemetry/javascript-approvers

api/.github/workflows/codeql-analysis.yml

@@ -0,0 +1,34 @@
+name: "CodeQL"
+
+on:
+  workflow_dispatch:
+  schedule:
+    #        ┌───────────── minute (0 - 59)
+    #        │  ┌───────────── hour (0 - 23)
+    #        │  │ ┌───────────── day of the month (1 - 31)
+    #        │  │ │ ┌───────────── month (1 - 12 or JAN-DEC)
+    #        │  │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
+    #        │  │ │ │ │
+    #        │  │ │ │ │
+    #        │  │ │ │ │
+    #        *  * * * *
+    - cron: '30 1 * * *'
+
+jobs:
+  CodeQL-Build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v1
+        with:
+          languages: javascript
+
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v1
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v1

api/.github/workflows/docs.yaml

@@ -0,0 +1,27 @@
+name: Deploy API Documentation
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout 🛎️
+        uses: actions/checkout@v2
+
+      - name: Install root dependencies
+        run: npm install --ignore-scripts
+
+      - name: Build 🔧
+        run: |
+          npm run compile
+          npm run docs
+
+      - name: Deploy 🚀
+        uses: JamesIves/github-pages-deploy-action@releases/v3
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages # The branch the action should deploy to.
+          FOLDER: docs/out # The folder the action should deploy.

api/.github/workflows/lint.yaml

@@ -0,0 +1,37 @@
+name: Lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Lint markdown files
+        uses: docker://avtodev/markdown-lint:v1
+        with:
+          args: "./**/*.md -i ./CHANGELOG.md"
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build 🔧
+        run: npm run compile
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Check for Circular Dependencies
+        run: npm run cycle-check
+
+      - name: Generate Documentation 📜
+        run: npm run docs
+
+      - name: Test Docs
+        run: npm run docs:test

api/.github/workflows/release-please.yml

@@ -0,0 +1,33 @@
+on:
+  push:
+    branches:
+      - main
+name: release-please
+jobs:
+  release-please:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: GoogleCloudPlatform/release-please-action@v2
+        id: release
+        with:
+          token: ${{secrets.RELEASE_PR_TOKEN}}
+          release-type: node
+          package-name: "@opentelemetry/api"
+      # The logic below handles the npm publication:
+      - uses: actions/checkout@v2
+        # these if statements ensure that a publication only occurs when
+        # a new release is created:
+        if: ${{ steps.release.outputs.release_created }}
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 14
+          registry-url: 'https://registry.npmjs.org'
+        if: ${{ steps.release.outputs.release_created }}
+      - run: npm install
+        if: ${{ steps.release.outputs.release_created }}
+      - run: npm run compile
+        if: ${{ steps.release.outputs.release_created }}
+      - run: npm publish --tag next
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+        if: ${{ steps.release.outputs.release_created }}

api/.github/workflows/test.yaml

@@ -0,0 +1,58 @@
+name: Unit Tests
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  unit-test:
+    strategy:
+      fail-fast: false
+      matrix:
+        node: ["8", "10", "12", "14", "16"]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node }}
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Compile 🔧
+        run: npm run compile
+
+      - name: Unit tests
+        run: npm run test
+
+      - name: Report Coverage
+        run: npm run codecov
+        if: ${{ matrix.node == '14' }}
+
+  browser-tests:
+    runs-on: ubuntu-latest
+    container:
+      image: circleci/node:12-browsers
+    steps:
+      - name: Permission Setup
+        run: sudo chmod -R 777 /github /__w
+
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Install Dependencies
+        run: npm install
+
+      - name: Compile 🔧
+        run: npm run compile
+
+      - name: Unit tests
+        run: npm run test:browser
+
+      - name: Report Coverage
+        run: npm run codecov:browser