percy-selenium 1.0.0 → 1.0.2.pre.beta.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8f68750e4ecba2e810753f97e39f038a2e798201e326e5b01b2dbcb71abdcf4
-  data.tar.gz: 3d152a595681acfb6849a48f2aaa0f74583f70f11c2e5ddbce5591c32b9c4c20
+  metadata.gz: d0606f4bf32f8297b9ed4a33dd99a6ac6807a67e3c5753c1d53aebca197bc916
+  data.tar.gz: c2cf614fd642b15c293f55891405c8d101c220155ef3e8eabbe8abbdc11be1b2
 SHA512:
-  metadata.gz: 88c54fc694e3b02508bd1f8b3812543dd3eabc7b1fbad6a85a5b7fb3b3dc014f1bbdee89c799088b9c175719df586d926875d0678d659b3f31404c05fc7092a0
-  data.tar.gz: ddfd1237e437efe2fd5f8789983374a0793180e3aa4a751633122c20883c80fc38291459540e66e75167f89de6ee4f3d73c9fdaed6c517874ad56b9c2e9d28e5
+  metadata.gz: '09ec0b88cbee30f308e8936ec9cacc066de599dbf781648bb0399c7cfa6a515041fbfc433a04f6cc936b07ff0c488dc638c9162ec61c764d12191f4f7afb6179'
+  data.tar.gz: 15f97893d187ccdf06f59ec50941b953e2b348346e533464f2bf31d34d05dcbbe7c20e1ed90d1ae8a605c275392fda0e1772c686ad4239835c73b8965059f90a

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,55 @@
+---
+name: Bug report
+about: Create a report to help us fix the issue
+title: ''
+labels: ''
+assignees: ''
+---
+
+<!--
+## Have you read the "Debugging SDKs" doc yet?
+
+There are common setup gotchas that happen with Percy's SDKs, it would be worth reading
+the debugging document, which might already answer your question:
+https://docs.percy.io/docs/debugging-sdk
+
+## Reach out to Percy support instead?
+
+If you’re having issues that _aren’t SDK bugs_, it would be best for you to
+reach out to support instead: support@percy.io or
+https://www.browserstack.com/contact#technical-support
+-->
+
+## The problem
+
+Briefly describe the issue you are experiencing (or the feature you want to see
+added to Percy). Tell us what you were trying to do and what happened
+instead. Remember, this is _not_ a place to ask questions. For that, go to
+https://github.com/percy/cli/discussions/new
+
+## Environment
+
+- Node version:
+- `@percy/cli` version:
+- Version of Percy SDK you’re using:
+- If needed, a build or snapshot ID:
+- OS version:
+- Type of shell command-line [interface]:
+
+## Details
+
+If necessary, describe the problem you have been experiencing in more detail.
+
+## Debug logs
+
+If you are reporting a bug, _always_ include logs! [Give the "Debugging SDKs"
+document a quick read for how to gather logs](https://docs.percy.io/docs/debugging-sdks#debugging-sdks)
+
+Please do not trim or edit these logs, often times there are hints in the full
+logs that help debug what is going on.
+
+## Code to reproduce issue
+
+Given the nature of testing/environment bugs, it’s best to try and isolate the
+issue in a reproducible repo. This will make it much easier for us to diagnose
+and fix.

data/.github/release-drafter.yml

@@ -3,28 +3,26 @@ tag-template: 'v$RESOLVED_VERSION'
 categories:
   - title: '💥 Breaking Changes'
     labels:
-      - breaking
+      - 💥 breaking
   - title: '✨ Enhancements'
     labels:
-      - feature
-      - enhancement
+      - ✨ enhancement
   - title: '🐛 Bug Fixes'
     labels:
-      - fix
-      - bugfix
-      - bug
-  - title: '🏗  Maintenance'
+      - 🐛 bug
+  - title: '🏗 Maintenance'
     labels:
-      - chore
-      - dependencies
+      - 🧹 maintenance
+  - title: '⬆️⬇️ Dependency Updates'
+    labels:
+      - ⬆️⬇️ dependencies
 change-title-escapes: '\<*_&#@'
 version-resolver:
   major:
     labels:
-      - breaking
+      - 💥 breaking
   minor:
     labels:
-      - feature
-      - enhancement
+      - ✨ enhancement
   default: patch
 template: '$CHANGES'

data/.github/workflows/Semgrep.yml

@@ -0,0 +1,48 @@
+# Name of this GitHub Actions workflow.
+name: Semgrep
+
+on:
+  # Scan changed files in PRs (diff-aware scanning):
+  # The branches below must be a subset of the branches above
+  pull_request:
+    branches: ["master", "main"]
+  push:
+    branches: ["master", "main"]
+  schedule:
+    - cron: '0 6 * * *'
+
+
+permissions:
+  contents: read
+
+jobs:
+  semgrep:
+    # User definable name of this GitHub Actions job.
+    permissions:
+      contents: read  # for actions/checkout to fetch code
+      security-events: write  # for github/codeql-action/upload-sarif to upload SARIF results
+    name: semgrep/ci 
+    # If you are self-hosting, change the following `runs-on` value: 
+    runs-on: ubuntu-latest
+
+    container:
+      # A Docker image with Semgrep installed. Do not change this.
+      image: returntocorp/semgrep
+
+    # Skip any PR created by dependabot to avoid permission issues:
+    if: (github.actor != 'dependabot[bot]')
+
+    steps:
+      # Fetch project source with GitHub Actions Checkout.
+      - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
+      # Run the "semgrep ci" command on the command line of the docker image.
+      - run: semgrep ci --sarif --output=semgrep.sarif
+        env:
+            # Add the rules that Semgrep uses by setting the SEMGREP_RULES environment variable. 
+            SEMGREP_RULES: p/default # more at semgrep.dev/explore
+
+      - name: Upload SARIF file for GitHub Advanced Security Dashboard
+        uses: github/codeql-action/upload-sarif@6c089f53dd51dc3fc7e599c3cb5356453a52ca9e # v2.20.0
+        with:
+          sarif_file: semgrep.sarif
+        if: always()

data/.github/workflows/stale.yml

@@ -0,0 +1,30 @@
+name: 'Close stale issues and PRs'
+on:
+  schedule:
+    - cron: '0 19 * * 2'
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@v4
+        with:
+          stale-issue-message: >-
+            This issue is stale because it has been open for more than 14 days with no activity.
+            Remove stale label or comment or this will be closed in 14 days.
+          stale-pr-message: >-
+            This PR is stale because it has been open for more than 14 days with no activity.
+            Remove stale label or comment or this will be closed in 14 days.
+          close-issue-message: >-
+            This issue was closed because it has been stalled for 28 days with no activity.
+          close-pr-message: >-
+            This PR was closed because it has been stalled for 28 days with no activity.
+          days-before-issue-stale: 14
+          days-before-pr-stale: 14
+          # close 14 days _after_ initial warning
+          days-before-issue-close: 14
+          days-before-pr-close: 14
+          exempt-pr-labels: '❄️ on ice'
+          exempt-issue-labels: '🐛 bug,❄️ on ice,✨ enhancement'
+          exempt-all-assignees: true
+          stale-pr-label: '🍞 stale'

data/.github/workflows/test.yml

@@ -2,8 +2,12 @@ name: Test
 on:
   push:
     branches: [main]
-  pull_request:
   workflow_dispatch:
+    inputs:
+      branch:
+        required: false
+        type: string
+        default: master
 jobs:
   test:
     name: Test
@@ -13,6 +17,15 @@ jobs:
         ruby: ['2.6', '2.7']
     runs-on: ${{ matrix.os }}
     steps:
+      - uses: actions-ecosystem/action-regex-match@v2
+        id: regex-match
+        if: ${{ github.event_name == 'workflow_dispatch' }}
+        with:
+          text: ${{ github.event.inputs.branch }}
+          regex: '^[a-zA-Z0-9_/\-]+$'
+      - name: Break on invalid branch name
+        run: exit 1
+        if: ${{ github.event_name == 'workflow_dispatch' && steps.regex-match.outputs && steps.regex-match.outputs.match == '' }}
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
         with:
@@ -23,4 +36,30 @@ jobs:
           path: "./vendor/bundle"
           key: v1/${{ runner.os }}/ruby-${{ matrix.ruby }}/${{ hashFiles('**/Gemfile.lock') }}
           restore-keys: v1/${{ runner.os }}/ruby-${{ matrix.ruby }}/
-      - run: bundle exec rspec
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+      - uses: actions/cache@v3
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: v1/${{ runner.os }}/node-${{ matrix.node }}/${{ hashFiles('**/yarn.lock') }}
+          restore-keys: v1/${{ runner.os }}/node-${{ matrix.node }}/
+      - run: yarn
+      - name: Set up @percy/cli from git
+        if: ${{ github.event_name == 'workflow_dispatch' }}
+        run: |
+          cd /tmp
+          git clone --branch ${{ github.event.inputs.branch }} --depth 1 https://github.com/percy/cli
+          cd cli
+          PERCY_PACKAGES=`find packages -mindepth 1 -maxdepth 1 -type d | sed -e 's/packages/@percy/g' | tr '\n' ' '`
+          git log -1
+          yarn
+          yarn build
+          yarn global:link
+          cd ${{ github.workspace }} 
+          yarn remove @percy/cli && yarn link `echo $PERCY_PACKAGES`
+          npx percy --version
+      - run: npx percy exec --testing -- bundle exec rspec

data/CODEOWNERS

@@ -0,0 +1 @@
+* @percy/percy-product-reviewers

data/Gemfile

@@ -7,7 +7,8 @@ gem "guard-rspec", require: false
 
 group :test, :development do
   gem "webmock"
-  gem "puma"
+  gem "puma", '~> 5.6'
+  gem "rackup"
   gem "pry"
   gem "simplecov", require: false
 end

data/README.md

@@ -61,9 +61,4 @@ $ percy exec -- [ruby test command]
 
 - `driver` (**required**) - A selenium-webdriver driver instance
 - `name` (**required**) - The snapshot name; must be unique to each snapshot
-- `options` - Additional snapshot options (overrides any project options)
-  - `widths` - An array of widths to take screenshots at
-  - `min_height` - The minimum viewport height to take screenshots at
-  - `percy_css` - Percy specific CSS only applied in Percy's rendering environment
-  - `request_headers` - Headers that should be used during asset discovery
-  - `enable_javascript` - Enable JavaScript in Percy's rendering environment
+- `options` - [See per-snapshot configuration options](https://docs.percy.io/docs/cli-configuration#per-snapshot-configuration)

data/lib/percy.rb

@@ -25,11 +25,15 @@ module Percy
         url: driver.current_url,
         dom_snapshot: dom_snapshot,
         client_info: CLIENT_INFO,
-        environment_info: ENV_INFO,)
+        environment_info: ENV_INFO,
+        **options,)
 
       unless response.body.to_json['success']
         raise StandardError, data['error']
       end
+
+      body = JSON.parse(response.body)
+      body['data']
     rescue StandardError => e
       log("Could not take DOM snapshot '#{name}'")
 
@@ -89,7 +93,11 @@ module Percy
     uri = URI("#{PERCY_SERVER_ADDRESS}/#{url}")
 
     response = if data
-      Net::HTTP.post(uri, data.to_json)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.read_timeout = 600 # seconds
+      request = Net::HTTP::Post.new(uri.path)
+      request.body = data.to_json
+      http.request(request)
     else
       Net::HTTP.get_response(uri)
     end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Percy
-  VERSION = '1.0.0'.freeze
+  VERSION = '1.0.2-beta.0'.freeze
 end

data/package.json

@@ -0,0 +1,10 @@
+{
+    "private": true,
+    "scripts": {
+      "test": "percy exec --testing -- bundle exec rspec"
+    },
+    "devDependencies": {
+      "@percy/cli": "^1.16.0"
+    }
+  }
+  

data/spec/lib/percy/percy_spec.rb

@@ -1,3 +1,4 @@
+# rubocop:disable RSpec/MultipleDescribes
 RSpec.describe Percy, type: :feature do
   before(:each) do
     WebMock.disable_net_connect!(allow: '127.0.0.1', disallow: 'localhost')
@@ -89,7 +90,7 @@ RSpec.describe Percy, type: :feature do
         .to_return(status: 200, body: '{"success": "true" }', headers: {})
 
       visit 'index.html'
-      Percy.snapshot(page, 'Name')
+      data = Percy.snapshot(page, 'Name', widths: [944])
 
       expect(WebMock).to have_requested(:post, "#{Percy::PERCY_SERVER_ADDRESS}/percy/snapshot")
         .with(
@@ -100,8 +101,72 @@ RSpec.describe Percy, type: :feature do
               "<html><head><title>I am a page</title></head><body>Snapshot me\n</body></html>",
             client_info: "percy-selenium-ruby/#{Percy::VERSION}",
             environment_info: "selenium/#{Selenium::WebDriver::VERSION} ruby/#{RUBY_VERSION}",
+            widths: [944],
           }.to_json,
         ).once
+
+      expect(data).to eq(nil)
+    end
+
+    it 'sends snapshots for sync' do
+      stub_request(:get, "#{Percy::PERCY_SERVER_ADDRESS}/percy/healthcheck")
+        .to_return(status: 200, body: '', headers: {'x-percy-core-version': '1.0.0'})
+
+      stub_request(:get, "#{Percy::PERCY_SERVER_ADDRESS}/percy/dom.js")
+        .to_return(
+          status: 200,
+          body: 'window.PercyDOM = { serialize: () => document.documentElement.outerHTML };',
+          headers: {},
+        )
+
+      stub_request(:post, 'http://localhost:5338/percy/snapshot')
+        .to_return(status: 200, body: '{"success": "true", "data": "sync_data" }', headers: {})
+
+      visit 'index.html'
+      data = Percy.snapshot(page, 'Name', {sync: true})
+
+      expect(WebMock).to have_requested(:post, "#{Percy::PERCY_SERVER_ADDRESS}/percy/snapshot")
+        .with(
+          body: {
+            name: 'Name',
+            url: 'http://127.0.0.1:3003/index.html',
+            dom_snapshot:
+              "<html><head><title>I am a page</title></head><body>Snapshot me\n</body></html>",
+            client_info: "percy-selenium-ruby/#{Percy::VERSION}",
+            environment_info: "selenium/#{Selenium::WebDriver::VERSION} ruby/#{RUBY_VERSION}",
+            widths: [944],
+          }.to_json,
+        ).once
+
+      expect(data).to eq('sync_data')
+    end
+  end
+end
+
+RSpec.describe Percy, type: :feature do
+  before(:each) do
+    WebMock.reset!
+    WebMock.allow_net_connect!
+    Percy._clear_cache!
+  end
+
+  describe 'integration', type: :feature do
+    it 'sends snapshots to percy server' do
+      visit 'index.html'
+      Percy.snapshot(page, 'Name', widths: [375])
+      sleep 5 # wait for percy server to process
+      resp = Net::HTTP.get_response(URI("#{Percy::PERCY_SERVER_ADDRESS}/test/requests"))
+      requests = JSON.parse(resp.body)['requests']
+      healthcheck = requests[0]
+      expect(healthcheck['url']).to eq('/percy/healthcheck')
+
+      snap = requests[2]['body']
+      expect(snap['name']).to eq('Name')
+      expect(snap['url']).to eq('http://127.0.0.1:3003/index.html')
+      expect(snap['client_info']).to include('percy-selenium-ruby')
+      expect(snap['environment_info']).to include('selenium')
+      expect(snap['widths']).to eq([375])
     end
   end
 end
+# rubocop:enable RSpec/MultipleDescribes

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: percy-selenium
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.2.pre.beta.0
 platform: ruby
 authors:
 - Perceptual Inc.
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-28 00:00:00.000000000 Z
+date: 2024-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -101,16 +101,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/dependabot.yml"
 - ".github/release-drafter.yml"
+- ".github/workflows/Semgrep.yml"
 - ".github/workflows/changelog.yml"
 - ".github/workflows/lint.yml"
 - ".github/workflows/release.yml"
+- ".github/workflows/stale.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".yardopts"
+- CODEOWNERS
 - Gemfile
 - Guardfile
 - LICENSE
@@ -119,6 +123,7 @@ files:
 - Rakefile
 - lib/percy.rb
 - lib/version.rb
+- package.json
 - percy-selenium.gemspec
 - spec/fixture/index.html
 - spec/lib/percy/percy_spec.rb
@@ -129,7 +134,7 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/percy/percy-selenium-ruby/issues
   source_code_uri: https://github.com/percy/percy-selenium-ruby
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -144,8 +149,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: Percy visual testing for Ruby Selenium
 test_files: