elasticgraph-graphiql 1.0.0.rc3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 385d5969cb0ffe906b559de2c50c9182f45f814341b072da7052e4e3f28ab115
+  data.tar.gz: e11e3c79fe25bf0482a4c942cee73f5cfb57eac317fa889f40518b50485ec337
+SHA512:
+  metadata.gz: 00e94e01fbfccf322438494b9a1e7faf4bfafca1e7646193e97f21ee583c6266c24ffec70f615add6baec437d9d57922efdf7a38f0d2d7a993c7a9db931fff8c
+  data.tar.gz: 79ce29f7e96f13295562aa4389c60913cf1aac9fd9064f66103ebeaa291620bb56edd151edeb7f1380c0ffb54635621a1cb5c96d3f13930b052528d1afbe9a30

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 - 2025 Block, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# ElasticGraph::GraphiQL
+
+Provides a GraphiQL IDE for ElasticGraph projects.
+
+Here's an example `config.ru`:
+
+``` ruby
+require 'elastic_graph/graphql'
+require 'elastic_graph/graphiql'
+
+graphql = ElasticGraph::GraphQL.from_yaml_file("path/to/config.yaml")
+run ElasticGraph::GraphiQL.new(graphql)
+```
+
+Run this with `rackup` (after installing the `rackup` gem) or any other rack-compatible server.
+
+## Dependency Diagram
+
+```mermaid
+graph LR;
+    classDef targetGemStyle fill:#FADBD8,stroke:#EC7063,color:#000,stroke-width:2px;
+    classDef otherEgGemStyle fill:#A9DFBF,stroke:#2ECC71,color:#000;
+    classDef externalGemStyle fill:#E0EFFF,stroke:#70A1D7,color:#2980B9;
+    elasticgraph-graphiql["elasticgraph-graphiql"];
+    class elasticgraph-graphiql targetGemStyle;
+    elasticgraph-rack["elasticgraph-rack"];
+    elasticgraph-graphiql --> elasticgraph-rack;
+    class elasticgraph-rack otherEgGemStyle;
+    elasticgraph-local["elasticgraph-local"];
+    elasticgraph-local --> elasticgraph-graphiql;
+    class elasticgraph-local otherEgGemStyle;
+```
+
+## License
+
+elasticgraph-graphiql is released under the [MIT License](https://opensource.org/licenses/MIT).
+
+Part of the distributed code comes from the [GraphiQL project](https://github.com/graphql/graphiql),
+also licensed under the MIT License, Copyright (c) GraphQL Contributors.

data/lib/elastic_graph/graphiql/assets_info.md

@@ -0,0 +1,6 @@
+The `assets.tar.gz` tarball was built using the `elasticgraph-graphiql/scripts/update_graphiql` script, which
+also updates this file.
+
+It was last run using git ref `graphiql@5.0.4` and it sourced GraphiQL from:
+
+https://github.com/graphql/graphiql/tree/graphiql@5.0.4/examples/graphiql-vite

data/lib/elastic_graph/graphiql.rb

@@ -0,0 +1,64 @@
+# Copyright 2024 - 2025 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require "elastic_graph/rack/graphql_endpoint"
+require "open3"
+require "rack/builder"
+require "rack/static"
+require "shellwords"
+require "tmpdir"
+
+module ElasticGraph
+  # A [Rack](https://github.com/rack/rack) application that serves both an ElasticGraph GraphQL endpoint
+  # and a [GraphiQL IDE](https://github.com/graphql/graphiql). This can be used for local development,
+  # mounted in a [Rails](https://rubyonrails.org/) application, or run in any other Rack-compatible context.
+  #
+  # @example Simple config.ru to serve an ElasticGraph GraphiQL IDE
+  #   require "elastic_graph/graphql"
+  #   require "elastic_graph/graphiql"
+  #
+  #   graphql = ElasticGraph::GraphQL.from_yaml_file("config/settings/development.yaml")
+  #   run ElasticGraph::GraphiQL.new(graphql)
+  module GraphiQL
+    # Builds a [Rack](https://github.com/rack/rack) application that serves both an ElasticGraph GraphQL endpoint
+    # and a [GraphiQL IDE](https://github.com/graphql/graphiql).
+    #
+    # @param graphql [ElasticGraph::GraphQL] ElasticGraph GraphQL instance
+    # @return [Rack::Builder] built Rack application
+    def self.new(graphql, output: $stdout)
+      tarball_path = ::File.join(__dir__.to_s, "graphiql/assets.tar.gz")
+      static_content_root = ::Dir.mktmpdir("elasticgraph_graphiql")
+      output.puts "Extracting GraphiQL assets from #{tarball_path} to #{static_content_root}..."
+
+      tar_command = "tar -xzf #{::Shellwords.escape(tarball_path)} -C #{::Shellwords.escape(static_content_root)}"
+      tar_output, status = ::Open3.capture2e(tar_command)
+
+      unless status.success?
+        error_message = "Failed to extract GraphiQL assets from #{tarball_path}.\n"
+        error_message += "Command: '#{tar_command}'\n"
+        error_message += "Exit Status: #{status.exitstatus}\n"
+        error_message += "Output: #{tar_output}"
+
+        raise error_message
+      end
+
+      output.puts "GraphiQL assets extracted successfully to #{static_content_root}."
+      graphql_endpoint = Rack::GraphQLEndpoint.new(graphql)
+
+      ::Rack::Builder.new do
+        # @type self: ::Rack::Builder
+        use ::Rack::Static, urls: ["/assets", "/favicon.svg", "/monacoeditorwork"], root: static_content_root
+        use ::Rack::Static, urls: {"/" => "index.html"}, root: static_content_root
+
+        map "/graphql" do
+          run graphql_endpoint
+        end
+      end
+    end
+  end
+end

data/script/update_graphiql

@@ -0,0 +1,187 @@
+#!/usr/bin/env ruby
+
+# Copyright 2024 - 2025 Block, Inc.
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+#
+# frozen_string_literal: true
+
+require "fileutils"
+require "open3"
+require "optparse"
+require "shellwords"
+require "tmpdir"
+
+# --- Configuration Constants ---
+GRAPHIQL_REPO_URL = "https://github.com/graphql/graphiql"
+VITE_EXAMPLE_SUBPATH = File.join("examples", "graphiql-vite")
+VITE_EXAMPLE_PACKAGE_NAME = "example-graphiql-vite"
+TARGET_ASSETS_TARBALL_PATH = File.expand_path("../lib/elastic_graph/graphiql/assets.tar.gz", __dir__)
+ELASTICGRAPH_FAVICONS_SOURCE_DIR = File.expand_path("../../config/site/src/assets/favicons", __dir__)
+
+# --- Options Parsing ---
+git_ref = nil
+
+OptionParser.new do |opts|
+  opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
+  opts.separator ""
+  opts.separator "Specific options:"
+
+  opts.on("-r REF", "--ref REF", String, "Git ref (tag, branch, commit SHA) of the graphql/graphiql repository to use") do |ref|
+    git_ref = ref
+  end
+
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end.parse!
+
+unless git_ref
+  raise "Must provide a `--ref`."
+end
+
+def run_command(command, in_dir: nil, env_vars: {})
+  puts "Executing: #{command} #{"(in dir: #{in_dir})" if in_dir}"
+
+  full_command_env = ENV.to_h.merge(env_vars)
+  stdout_str, stderr_str, status = Open3.capture3(full_command_env, command, chdir: in_dir || Dir.pwd)
+
+  unless status.success?
+    puts "Error executing command: #{command}"
+    puts "STDOUT:\n#{stdout_str}" unless stdout_str.empty?
+    puts "STDERR:\n#{stderr_str}" unless stderr_str.empty?
+    puts "Exit status: #{status.exitstatus}"
+
+    raise "Command failed: #{command}"
+  end
+
+  stdout_str
+end
+
+# --- Main Script Logic ---
+puts "Script update_graphiql started."
+puts "Configuration:"
+puts "  GraphiQL Repo URL: #{GRAPHIQL_REPO_URL}"
+puts "  GraphiQL Git Ref: #{git_ref}"
+puts "  Target Example Subpath: #{VITE_EXAMPLE_SUBPATH}"
+puts "  Target Example Package Name: #{VITE_EXAMPLE_PACKAGE_NAME}"
+puts "  Target Archive Path: #{TARGET_ASSETS_TARBALL_PATH}"
+puts "  ElasticGraph Favicons Source: #{ELASTICGRAPH_FAVICONS_SOURCE_DIR}"
+
+puts "\nStarting main operations..."
+Dir.mktmpdir("graphiql_build") do |temp_dir|
+  puts "Created temporary directory for build: #{temp_dir}"
+
+  repo_clone_subdir = "graphiql_repo"
+  repo_clone_path = File.join(temp_dir, repo_clone_subdir)
+  FileUtils.mkdir_p(repo_clone_path)
+
+  puts "\nCloning graphql/graphiql repository (ref: #{git_ref}) into #{repo_clone_path}..."
+  run_command("git clone #{GRAPHIQL_REPO_URL}.git .", in_dir: repo_clone_path)
+  puts "Checking out git ref: #{git_ref}..."
+  run_command("git checkout #{Shellwords.escape(git_ref)}", in_dir: repo_clone_path)
+  puts "Successfully cloned and checked out ref: #{git_ref}."
+
+  example_dir = File.join(repo_clone_path, VITE_EXAMPLE_SUBPATH)
+  unless Dir.exist?(example_dir)
+    raise "Example path #{VITE_EXAMPLE_SUBPATH} not found after clone and checkout in #{repo_clone_path}."
+  end
+  puts "Found example path: #{example_dir}"
+
+  app_jsx_path = File.join(example_dir, "src", "App.jsx")
+  unless File.exist?(app_jsx_path)
+    raise "#{app_jsx_path} not found. Skipping fetcher URL modification."
+  end
+
+  puts "\nModifying #{app_jsx_path} to use local /graphql endpoint..."
+  app_content = File.read(app_jsx_path)
+  original_fetch_url = "https://graphql.earthdata.nasa.gov/api"
+  target_fetch_url = "/graphql"
+  if app_content.gsub!(original_fetch_url, target_fetch_url)
+    File.write(app_jsx_path, app_content)
+    puts "Successfully updated fetch URL in #{app_jsx_path} to '#{target_fetch_url}'."
+  else
+    raise "Could not find expected remote fetch URL ('#{original_fetch_url}') in #{app_jsx_path}."
+  end
+
+  puts "\nInstalling dependencies from root (#{repo_clone_path}) using Yarn..."
+  run_command("yarn install --frozen-lockfile", in_dir: repo_clone_path, env_vars: {"NODE_OPTIONS" => "--max-old-space-size=4096"})
+
+  puts "\nBuilding packages using Yarn..."
+  run_command("yarn build", in_dir: repo_clone_path, env_vars: {"NODE_OPTIONS" => "--max-old-space-size=4096"})
+
+  puts "\nBuilding GraphiQL example (#{VITE_EXAMPLE_PACKAGE_NAME}) using Yarn workspace..."
+  run_command("yarn workspace #{VITE_EXAMPLE_PACKAGE_NAME} build", in_dir: repo_clone_path, env_vars: {"NODE_OPTIONS" => "--max-old-space-size=4096"})
+
+  dist_path = File.join(example_dir, "dist")
+  index_html_in_dist_path = File.join(dist_path, "index.html")
+  unless Dir.exist?(dist_path) && File.exist?(index_html_in_dist_path)
+    raise "Build output directory '#{dist_path}' or 'index.html' not found after build."
+  end
+  puts "Build successful. Assets found in: #{dist_path}"
+
+  # Modify dist/index.html (title) BEFORE archiving
+  puts "\nModifying #{index_html_in_dist_path} for title..."
+  index_html_content = File.read(index_html_in_dist_path)
+
+  # Update Title
+  original_title_pattern = /<title>GraphiQL Vite Example<\/title>/i
+  target_title = "<title>ElasticGraph GraphiQL</title>"
+  if index_html_content.gsub!(original_title_pattern, target_title)
+    puts "Successfully updated title in HTML content buffer."
+  else
+    raise "Could not find original title ('GraphiQL Vite Example') in HTML content buffer."
+  end
+
+  # Favicon Replacement: Replace the example's favicon.svg with ElasticGraph's version.
+  # The graphiql-vite example's index.html already links to /favicon.svg.
+  puts "\nProcessing favicon replacement..."
+  elasticgraph_favicon_svg_source = File.join(ELASTICGRAPH_FAVICONS_SOURCE_DIR, "favicon.svg")
+  target_favicon_in_dist = File.join(dist_path, "favicon.svg")
+
+  puts "  Source ElasticGraph favicon path: #{elasticgraph_favicon_svg_source}"
+  puts "  Target favicon path in dist: #{target_favicon_in_dist}"
+
+  unless File.exist?(elasticgraph_favicon_svg_source)
+    raise "ElasticGraph favicon.svg NOT FOUND at source (#{elasticgraph_favicon_svg_source})."
+  end
+
+  FileUtils.cp(elasticgraph_favicon_svg_source, target_favicon_in_dist)
+  puts "  SUCCESS: Copied ElasticGraph favicon.svg to #{target_favicon_in_dist}."
+
+  # Write all accumulated HTML changes (title)
+  File.write(index_html_in_dist_path, index_html_content)
+  puts "Finished HTML modifications and favicon replacement."
+
+  # Create tar.gz archive
+  archive_parent_dir = File.dirname(TARGET_ASSETS_TARBALL_PATH)
+  FileUtils.mkdir_p(archive_parent_dir)
+  archive_filename = File.basename(TARGET_ASSETS_TARBALL_PATH)
+  temp_archive_file_path = File.join(temp_dir, archive_filename)
+
+  puts "\nCreating tarball: #{temp_archive_file_path} from contents of #{dist_path}..."
+  tar_command = "tar -czvf #{Shellwords.escape(temp_archive_file_path)} -C #{Shellwords.escape(dist_path)} ."
+  run_command(tar_command)
+
+  puts "Moving tarball from #{temp_archive_file_path} to #{TARGET_ASSETS_TARBALL_PATH}..."
+  FileUtils.mv(temp_archive_file_path, TARGET_ASSETS_TARBALL_PATH)
+  puts "Tarball successfully created at #{TARGET_ASSETS_TARBALL_PATH}"
+
+  # Record the GraphiQL git ref we used so there's a record of it.
+  ::File.write(::File.expand_path("../assets_info.md", TARGET_ASSETS_TARBALL_PATH), <<~EOS)
+    The `assets.tar.gz` tarball was built using the `elasticgraph-graphiql/scripts/update_graphiql` script, which
+    also updates this file.
+
+    It was last run using git ref `#{git_ref}` and it sourced GraphiQL from:
+
+    #{GRAPHIQL_REPO_URL}/tree/#{git_ref}/#{VITE_EXAMPLE_SUBPATH}
+  EOS
+
+  puts "\nOperations in temporary directory completed."
+end
+
+puts "Temporary directory cleaned up."
+puts "\nScript completed successfully."

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: elasticgraph-graphiql
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc3
+platform: ruby
+authors:
+- Myron Marston
+- Ben VandenBos
+- Block Engineering
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc3
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc3
+- !ruby/object:Gem::Dependency
+  name: elasticgraph-opensearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc3
+email:
+- myron@squareup.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/elastic_graph/graphiql.rb
+- lib/elastic_graph/graphiql/assets.tar.gz
+- lib/elastic_graph/graphiql/assets_info.md
+- script/update_graphiql
+homepage: https://block.github.io/elasticgraph/
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/block/elasticgraph/issues
+  changelog_uri: https://github.com/block/elasticgraph/releases/tag/v1.0.0.rc3
+  documentation_uri: https://block.github.io/elasticgraph/api-docs/v1.0.0.rc3/
+  homepage_uri: https://block.github.io/elasticgraph/
+  source_code_uri: https://github.com/block/elasticgraph/tree/v1.0.0.rc3/elasticgraph-graphiql
+  gem_category: local
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.4'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '3.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Provides a GraphiQL IDE for ElasticGraph projects.
+test_files: []