@elastic/synthetics 1.0.0-beta.2 → 1.0.0-beta.22

package/CHANGELOG.md

@@ -2,6 +2,241 @@
 
 All notable changes to this project will be documented in this file.
 
+## v1.0.0-beta.20 (2021-02-16)
+
+### Bug fixes
+
+- Capture syntax errors inside inline journeys without throwing
+  promise rejection errors #450
+
+## v1.0.0-beta.19 (2021-01-31)
+
+### Bug fixes
+
+- Ensure `journey/end` is written to file descriptor by flushing out the
+  last bytes in underlying stream #446
+- Debug logs should be logged to stdout instead of using the reporter
+  file descriptor #423
+
+## v1.0.0-beta.18 (2021-01-13)
+
+### Bug fixes
+
+- Do not read configuration files for inline journeys unless a --config parameter is passed #426
+- Stop runner from hanging indefinitely within ubuntu docker images [elastic/beats#29681] #441
+
+## v1.0.0-beta.17 (2021-11-11)
+
+### Breaking Changes
+
+- Remove 'suiteparams' CLI option which was depreacted in the previous releases.
+  Use `--params` instead [#406](https://github.com/elastic/synthetics/pull/406)
+
+### Features
+
+- Add support for `--playwright-options` CLI flag that lets user specify all
+  browser and context options that Playwright supports in addition to passing it
+  via `synthetics.config.js` file [#405](https://github.com/elastic/synthetics/pull/405)
+
+### Bug fixes
+
+- Timestamp of `journey/end` event reflects the time when the event happens instead
+  of the time event was written to the output stream. This fixes issue when
+  duration is calculated based on `journey/start` and `journey/end` [#409](https://github.com/elastic/synthetics/pull/409)
+- Rewrite screenshot timestamp based on when screenshot was taken instead of
+  when the screenshot was processed and reconstructed [#411](https://github.com/elastic/synthetics/pull/411)
+
+## v1.0.0-beta.16 (2021-10-19)
+
+### Bug fixes
+
+- Revert to Playwright `1.14.0` as the newer versions of chromium
+  [breaks](https://bugs.chromium.org/p/chromium/issues/detail?id=1253967&q=glibc&can=2)
+  CentOS7. As a result of this revert, network events from other contexts like
+  popups, iframes, tabs would not get captured [#402](https://github.com/elastic/synthetics/pull/402)
+
+## v1.0.0-beta.15 (2021-10-14)
+
+### Breaking Changes
+
+- Drop support for Node 12 [#397](https://github.com/elastic/synthetics/pull/397)
+
+### Features
+
+- Enable trace events when invoked via Heartbeat, enables step level metrics
+  like FCP, LCP and other performance metrics for all journeys [#387](https://github.com/elastic/synthetics/pull/387)
+- Use network events from playwright context which captures network requests
+  from iframes, new tabs, etc. [#372](https://github.com/elastic/synthetics/pull/372)
+- Add default network emulation for journeys to be able to capture performance
+  measurements more effectively. Default is 5Mbps download, 3Mbps Upload and 20ms latency.
+  Users can control network throttling with `--throttling '10d/2u/30l'` flag or
+  can disable the throttling via `--no-throttling` flag [#284](https://github.com/elastic/synthetics/pull/284)
+- Add `Elastic/Synthetics` user-agent identifier to all network
+  requests. This enables users to analyze traffic from Elastic Synthetic
+  monitoring platform [#232](https://github.com/elastic/synthetics/pull/232)
+- Introduce more assetion commands to formatter [#385](https://github.com/elastic/synthetics/pull/385)
+
+### Bug fixes
+
+- Account for page closing while capturing network events [#398](https://github.com/elastic/synthetics/pull/398)
+
+## v1.0.0-beta.14 (2021-09-16)
+
+### Bug fixes
+
+- Bring back `--suite-params` flag support to support Heartbeat 7.15 [#379](https://github.com/elastic/synthetics/pull/379)
+
+## v1.0.0-beta.13 (2021-09-16)
+
+### Features
+
+- Add step level tracing API which enables capturing performance metrics (core
+  web vitals) for each navigation as part of the journey [#369](https://github.com/elastic/synthetics/pull/369)
+- Capture all page errors and unhandled exceptions as part of the journeys [#374](https://github.com/elastic/synthetics/pull/374)
+- Introduce synthetics script generator which can transform the recorder actions
+  into code [#375](https://github.com/elastic/synthetics/pull/375)
+
+## v1.0.0-beta.12 (2021-08-19)
+
+### Features
+
+- Add support for expect assertions for inline suites
+  [#365](https://github.com/elastic/synthetics/pull/365)
+- Add `ignore-https-errors` to the CLI to ignore any HTTPS errors during
+  navigation [#361](https://github.com/elastic/synthetics/pull/361)
+
+### Notable changes
+
+- Bump playwright to 1.14.0
+  [#366](https://github.com/elastic/synthetics/pull/366)
+- Bump Node.js version to 14 [#364](https://github.com/elastic/synthetics/pull/364)
+
+## v1.0.0-beta.11 (2021-08-09)
+
+### Breaking Changes
+
+- Drop support for Heartbeat 7.13
+  [#354](https://github.com/elastic/synthetics/pull/354)
+
+### Features
+
+- Add quiet mode for Heartbeat via `--quiet-exit-code` and make
+  it default for > 7.14 Heartbeat versions [#357](https://github.com/elastic/synthetics/pull/357)
+
+## v1.0.0-beta.10 (2021-07-27)
+
+### Bug fixes
+
+- Record correct screenshots for popups in new tabs
+  and windows [#353](https://github.com/elastic/synthetics/pull/353)
+- Capture URL correctly for steps that involve navigations inside
+  popups and windows [#352](https://github.com/elastic/synthetics/pull/352)
+
+## v1.0.0-beta.9 (2021-07-13)
+
+### Bug fixes
+
+- Populate journey id when its not explicitly specified
+  [#346](https://github.com/elastic/synthetics/pull/346)
+- Remove Node.js 12 version restriction [#343](https://github.com/elastic/synthetics/pull/343)
+
+## v1.0.0-beta.8 (2021-07-07)
+
+### Bug fixes
+
+- Capture screenshots correctly when using device emulation [#340](https://github.com/elastic/synthetics/pull/340)
+
+## v1.0.0-beta.7 (2021-07-01)
+
+### Features
+
+- Deprecate 'suiteparams' infavor of 'params' [#331](https://github.com/elastic/synthetics/pull/331)
+
+### Bug fixes
+
+- Bring `--network` flag back till 7.14 is released [#336](https://github.com/elastic/synthetics/pull/336)
+
+## v1.0.0-beta.6 (2021-06-30)
+
+### Bug fixes
+
+- Bring `--json` flag back till 7.14 is released [#333](https://github.com/elastic/synthetics/pull/333)
+
+## v1.0.0-beta.5 (2021-06-30)
+
+### Features
+
+- Add support for passing playwright context and browser options via
+  synthetics config [#317](https://github.com/elastic/synthetics/pull/317)
+
+### Bug fixes
+
+- Compability bug with FS apis on Node 12 [#328](https://github.com/elastic/synthetics/pull/328)
+- Add fallback symbols for non utf8 support in windows [#324](https://github.com/elastic/synthetics/pull/324)
+
+## v1.0.0-beta.4 (2021-06-28)
+
+### Breaking Changes
+
+- Remove -e from CLI args and use `NODE_ENV` for controlling the
+  environment [#318](https://github.com/elastic/synthetics/pull/318)
+
+### Features
+
+- Add new screenshots options - `on|off|only-on-failure` to manage capturing
+  the step screenshots [#311](https://github.com/elastic/synthetics/pull/311)
+- Enable screenshot deduplication feature by default when the agent is invoked
+  via Heartbeat [#322](https://github.com/elastic/synthetics/pull/322)
+
+### Bug fixes
+
+- Avoid creating duplicate screenshot JSON docs for each journey
+  [#320](https://github.com/elastic/synthetics/pull/320)
+- Associate `beforeAll` hook errors across all journeys
+  [#316](https://github.com/elastic/synthetics/pull/316)
+- Provide journey isolation via context [#314](https://github.com/elastic/synthetics/pull/314)
+
+## v1.0.0-beta.3 (2021-06-15)
+
+### Features
+
+- Capture all core-vitals and user experience metrics like FPC, LCP, CLS, User
+  timing metrics, etc via chrome tracing [#194](https://github.com/elastic/synthetics/pull/194)
+- Split the captured screenshot from each step in to 64 blocks to optimzie
+  the storage when indexed the same block in Elaticsearch [#290](https://github.com/elastic/synthetics/pull/290)
+- Add support for filtering journeys by name and tags [#300](https://github.com/elastic/synthetics/issues/300)
+- Expose `expect` assetion method in the API [#201](https://github.com/elastic/synthetics/issues/201)
+- Update Cumulative Layout Shift(CLS) metric based on
+  `maximum session window with 1 second gap, capped at 5 seconds`
+  [#301](https://github.com/elastic/synthetics/issues/301)
+- Expose time taken to complete single step under
+  `step.duration.us` [#302](https://github.com/elastic/synthetics/issues/301)
+- Expose new capabilities via `--capability` through CLI
+  options [#295](https://github.com/elastic/synthetics/issues/295)
+- Add new flag `--rich-events` which mimicks heartbeat
+  behaviour [#289](https://github.com/elastic/synthetics/pull/289).
+- Expose suite parameters from CLI and config file to
+  all hooks and journeys callbacks[#272](https://github.com/elastic/synthetics/pull/272)
+
+### Bug fixes
+
+- Move all of the trace events like FCP, LCP, User timings under
+  `browser.relative_trace`[#303](https://github.com/elastic/synthetics/pulls/303)
+- Prioritize suite params from CLI over config file [#298](https://github.com/elastic/synthetics/pull/298)
+- Report errors from `before` and `after` hooks [#273](https://github.com/elastic/synthetics/pull/273)
+
+## v1.0.0-beta.2 (2021-05-17)
+
+### Features
+
+- Allow dynamic suite parameters configuration via `synthetics.config.{js|ts}`
+  [#270](https://github.com/elastic/synthetics/issues/270)
+
+### Performance Improvements
+
+- Improve execution time of test suites by spawning journeys in isolated context
+  instead of launcing browser for each run [#274](https://github.com/elastic/synthetics/issues/274)
+
 ## v1.0.0-beta.1 (2021-05-04)
 
 ### Bug fixes

package/NOTICE.txt

@@ -0,0 +1,250 @@
+@elastic/synthetics
+Copyright (c) 2020-present, Elasticsearch BV
+
+
+---------------------------------------------------------------------------
+This product relies on `googlechrome/lighthouse`
+
+Copyright 2017 The Lighthouse Authors. All Rights Reserved.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+---------------------------------------------------------------------------
+This product relies on `expect`
+
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates. All Rights Reserved.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+---------------------------------------------------------------------------
+This product relies on `ChromeDevTools/devtools-frontend`
+
+// Copyright 2014 The Chromium Authors. All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//    * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//    * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//    * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -1,4 +1,5 @@
-[![Build Status](https://apm-ci.elastic.co/job/apm-agent-rum/job/elastic-synthetics/job/master/badge/icon)](https://apm-ci.elastic.co/job/apm-agent-rum/job/elastic-synthetics/job/master/)
+[![Build Status](https://apm-ci.elastic.co/job/apm-agent-rum/job/elastic-synthetics/job/main/badge/icon)](https://apm-ci.elastic.co/job/apm-agent-rum/job/elastic-synthetics/job/main/)
+
 # Experimental Synthetics Agent
 
 Synthetic Monitoring with Real Browsers.