add injected message

Author: motdotla

CHANGELOG.md

@@ -2,7 +2,11 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
-## [Unreleased](https://github.com/dotenvx/dotenvx-ruby/compare/v4.0.0...main)
+## [Unreleased](https://github.com/dotenvx/dotenvx-ruby/compare/v4.0.4...main)
+
+## [4.0.4](https://github.com/dotenvx/dotenvx-ruby/compare/v4.0.3...v4.0.4)
+
+- Report the unique variables injected from readable dotenv files.
 
 ## [4.0.0](https://github.com/dotenvx/dotenvx-ruby/compare/v0.0.2...v4.0.0)
 

Cargo.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    dotenvx (4.0.3)
+    dotenvx (4.0.4)
       rb_sys (~> 0.9)
-    dotenvx-rails (4.0.3)
-      dotenvx (= 4.0.3)
+    dotenvx-rails (4.0.4)
+      dotenvx (= 4.0.4)
       railties (>= 5.0)
 
 GEM

Gemfile.lock

@@ -1,6 +1,6 @@
 [package]
 name = "dotenvx_native"
-version = "4.0.3"
+version = "4.0.4"
 edition = "2021"
 rust-version = "1.83"
 publish = false

ext/dotenvx/Cargo.toml

@@ -1,6 +1,7 @@
 require "dotenvx/version"
 require "dotenvx/dotenvx_native"
 require "json"
+require "pathname"
 
 module Dotenvx
   class MissingKeys < RuntimeError
@@ -16,8 +17,14 @@ class << self
     attr_accessor :instrumenter
 
     def load(*filenames, overwrite: false, ignore: true)
-      env = parse(*filenames, overwrite: overwrite, ignore: ignore)
-      update(env, overwrite: overwrite)
+      env, injected_keys, loaded_paths = parse_files(
+        *filenames,
+        overwrite: overwrite,
+        ignore: ignore
+      )
+      changed = update(env, overwrite: overwrite)
+      log_injected(injected_keys, loaded_paths)
+      changed
     end
 
     def load!(*filenames)
@@ -35,31 +42,7 @@ def overwrite!(*filenames)
     alias overload! overwrite!
 
     def parse(*filenames, overwrite: false, ignore: true)
-      filenames = [".env"] if filenames.empty?
-      filenames = filenames.flatten.reverse if overwrite
-
-      process_env = ENV.to_h
-      filenames.reduce({}) do |values, filename|
-        path = File.expand_path(filename)
-        begin
-          source = File.binread(path).sub(/\A\xEF\xBB\xBF/, "").force_encoding(Encoding::UTF_8)
-        rescue Errno::ENOENT, Errno::EISDIR
-          raise unless ignore
-          next values
-        end
-
-        parsed, = Native.parse_dotenv(JSON.generate(
-          source: source,
-          process_env: process_env,
-          overwrite: overwrite == true,
-          key_files: key_files(path)
-        ))
-        parsed = parsed.to_h
-        process_env.merge!(parsed)
-        values.merge!(parsed)
-        yield Environment.new(path, parsed) if block_given?
-        values
-      end
+      parse_files(*filenames, overwrite: overwrite, ignore: ignore).first
     end
 
     def update(env = {}, overwrite: false)
@@ -89,6 +72,56 @@ def require_keys(*keys)
 
     private
 
+    def parse_files(*filenames, overwrite: false, ignore: true)
+      filenames = [".env"] if filenames.empty?
+      filenames = filenames.flatten.reverse if overwrite
+
+      process_env = ENV.to_h
+      injected_keys = {}
+      loaded_paths = []
+      values = filenames.reduce({}) do |accumulator, filename|
+        path = File.expand_path(filename)
+        begin
+          source = File.binread(path).sub(/\A\xEF\xBB\xBF/, "").force_encoding(Encoding::UTF_8)
+        rescue Errno::ENOENT, Errno::EISDIR
+          raise unless ignore
+          next accumulator
+        end
+
+        parsed, injected = Native.parse_dotenv(JSON.generate(
+          source: source,
+          process_env: process_env,
+          overwrite: overwrite == true,
+          key_files: key_files(path)
+        ))
+        parsed = parsed.to_h
+        injected.each { |key, _value| injected_keys[key] = true }
+        loaded_paths << path
+        process_env.merge!(parsed)
+        accumulator.merge!(parsed)
+        yield Environment.new(path, parsed) if block_given?
+        accumulator
+      end
+      [values, injected_keys.keys, loaded_paths]
+    end
+
+    def log_injected(injected_keys, loaded_paths)
+      message = "⟐ injected env (#{injected_keys.length})"
+      unless loaded_paths.empty?
+        paths = loaded_paths.map { |path| readable_path(path) }
+        message = "#{message} from #{paths.join(", ")}"
+      end
+      warn message
+    end
+
+    def readable_path(path)
+      pathname = Pathname.new(path)
+      relative = pathname.relative_path_from(Pathname.pwd).to_s
+      relative.start_with?("../") ? pathname.to_s : relative
+    rescue ArgumentError
+      pathname.to_s
+    end
+
     def key_files(path)
       candidates = ["#{path}.keys", File.join(File.dirname(path), ".env.keys")]
       candidates.select { |candidate| File.file?(candidate) }

lib/dotenvx.rb

@@ -37,7 +37,10 @@ class Railtie < Rails::Railtie
     config.before_configuration { Dotenvx::Railtie.instance.load }
 
     def load
+      return if @loaded
+
       Dotenvx.load(*dotenvx_files)
+      @loaded = true
     end
 
     private

lib/dotenvx/rails.rb

@@ -1,3 +1,3 @@
 module Dotenvx
-  VERSION = "4.0.3"
+  VERSION = "4.0.4"
 end

lib/dotenvx/version.rb

@@ -11,7 +11,8 @@
     with_env_file("HELLO=World\nEXISTING=file\n") do |path|
       ENV["EXISTING"] = "environment"
 
-      expect(described_class.load(path)).to eq("HELLO" => "World")
+      expect { described_class.load(path) }
+        .to output("⟐ injected env (1) from #{path}\n").to_stderr
       expect(ENV["HELLO"]).to eq("World")
       expect(ENV["EXISTING"]).to eq("environment")
     end
@@ -21,25 +22,41 @@
     with_env_file("EXISTING=file\n") do |path|
       ENV["EXISTING"] = "environment"
 
-      expect(described_class.overwrite(path)).to eq("EXISTING" => "file")
+      expect { described_class.overwrite(path) }
+        .to output("⟐ injected env (1) from #{path}\n").to_stderr
       expect(ENV["EXISTING"]).to eq("file")
     end
   end
 
   it "parses without changing ENV" do
     with_env_file("PARSED=yes\n") do |path|
+      expect { described_class.parse(path) }.not_to output.to_stderr
       expect(described_class.parse(path)).to eq("PARSED" => "yes")
       expect(ENV).not_to have_key("PARSED")
     end
   end
 
+  it "counts unique injected keys across readable files" do
+    Dir.mktmpdir do |directory|
+      first = File.join(directory, ".env.local")
+      second = File.join(directory, ".env")
+      File.write(first, "FIRST=one\nSHARED=local\n")
+      File.write(second, "SECOND=two\nSHARED=base\nEXISTING=file\n")
+      ENV["EXISTING"] = "environment"
+
+      expect { described_class.load(first, second) }
+        .to output("⟐ injected env (3) from #{first}, #{second}\n").to_stderr
+    end
+  end
+
   it "decrypts with the adjacent dotenvx key file" do
     Dir.mktmpdir do |directory|
       path = File.join(directory, ".env")
       File.write(path, "HELLO=#{encrypted_world}\n")
       File.write("#{path}.keys", "DOTENV_PRIVATE_KEY=#{private_key}\n")
 
-      expect(described_class.load(path)).to eq("HELLO" => "World")
+      expect { described_class.load(path) }
+        .to output("⟐ injected env (1) from #{path}\n").to_stderr
       expect(ENV["HELLO"]).to eq("World")
     end
   end
@@ -50,15 +67,17 @@
       File.write(path, "HELLO=#{encrypted_world}\n")
       File.write(File.join(directory, ".env.keys"), "DOTENV_PRIVATE_KEY=#{private_key}\n")
 
-      expect(described_class.load(path)).to eq("HELLO" => "World")
+      expect { described_class.load(path) }
+        .to output("⟐ injected env (1) from #{path}\n").to_stderr
       expect(ENV["HELLO"]).to eq("World")
     end
   end
 
   it "ignores missing files by default and raises through load!" do
     missing = File.join(Dir.tmpdir, "dotenvx-does-not-exist")
 
-    expect(described_class.load(missing)).to eq({})
+    expect { expect(described_class.load(missing)).to eq({}) }
+      .to output("⟐ injected env (0)\n").to_stderr
     expect { described_class.load!(missing) }.to raise_error(Errno::ENOENT)
   end