-
+
@if ($is_shared)
@endif
- @else
-
- @if ($is_multiline)
-
-
- @else
-
-
- @endif
- @if ($is_shared)
-
- @endif
-
- @endif
- @else
-
-
-
- @if ($is_shared)
-
+ @if (!$isDisabled)
+
@endif
@endcan
@@ -167,23 +169,29 @@
helper="This means that when you use $VARIABLES in a value, it should be interpreted as the actual characters '$VARIABLES' and not as the value of a variable named VARIABLE.
Useful if you have $ sign in your value and there are some characters after it, but you would not like to interpolate it from another value. In this case, you should set this to true."
label="Is Literal?" />
@else
- @if ($isSharedVariable)
-
+ @if ($is_shared)
+
@else
- @if (!$env->is_nixpacks)
-
- @endif
-
- @if (!$env->is_nixpacks)
+ @if ($isSharedVariable)
- @if ($is_multiline === false)
-
+ @else
+ @if (!$env->is_nixpacks)
+
+ @endif
+
+ @if (!$env->is_nixpacks)
+
+ @if ($is_multiline === false)
+
+ @endif
@endif
@endif
@endif
@@ -229,22 +237,26 @@
helper="This means that when you use $VARIABLES in a value, it should be interpreted as the actual characters '$VARIABLES' and not as the value of a variable named VARIABLE.
Useful if you have $ sign in your value and there are some characters after it, but you would not like to interpolate it from another value. In this case, you should set this to true."
label="Is Literal?" />
@else
- @if ($isSharedVariable)
-
+ @if ($is_shared)
+
@else
- @if (!$env->is_nixpacks)
+ @if ($isSharedVariable)
+
+ @else
- @endif
-
-
- @if ($is_multiline === false)
-
+
+
+ @if ($is_multiline === false)
+
+ @endif
@endif
@endif
@endif
diff --git a/tests/Feature/EnvironmentVariableCommentTest.php b/tests/Feature/EnvironmentVariableCommentTest.php
new file mode 100644
index 000000000..05126c23a
--- /dev/null
+++ b/tests/Feature/EnvironmentVariableCommentTest.php
@@ -0,0 +1,120 @@
+user = User::factory()->create();
+ $this->team = Team::factory()->create();
+ $this->team->members()->attach($this->user, ['role' => 'owner']);
+ $this->application = Application::factory()->create([
+ 'team_id' => $this->team->id,
+ ]);
+
+ $this->actingAs($this->user);
+});
+
+test('environment variable can be created with comment', function () {
+ $env = EnvironmentVariable::create([
+ 'key' => 'TEST_VAR',
+ 'value' => 'test_value',
+ 'comment' => 'This is a test environment variable',
+ 'resourceable_type' => Application::class,
+ 'resourceable_id' => $this->application->id,
+ ]);
+
+ expect($env->comment)->toBe('This is a test environment variable');
+ expect($env->key)->toBe('TEST_VAR');
+ expect($env->value)->toBe('test_value');
+});
+
+test('environment variable comment is optional', function () {
+ $env = EnvironmentVariable::create([
+ 'key' => 'TEST_VAR',
+ 'value' => 'test_value',
+ 'resourceable_type' => Application::class,
+ 'resourceable_id' => $this->application->id,
+ ]);
+
+ expect($env->comment)->toBeNull();
+ expect($env->key)->toBe('TEST_VAR');
+});
+
+test('environment variable comment can be updated', function () {
+ $env = EnvironmentVariable::create([
+ 'key' => 'TEST_VAR',
+ 'value' => 'test_value',
+ 'comment' => 'Initial comment',
+ 'resourceable_type' => Application::class,
+ 'resourceable_id' => $this->application->id,
+ ]);
+
+ $env->comment = 'Updated comment';
+ $env->save();
+
+ $env->refresh();
+ expect($env->comment)->toBe('Updated comment');
+});
+
+test('environment variable comment is preserved when updating value', function () {
+ $env = EnvironmentVariable::create([
+ 'key' => 'TEST_VAR',
+ 'value' => 'initial_value',
+ 'comment' => 'Important variable for testing',
+ 'resourceable_type' => Application::class,
+ 'resourceable_id' => $this->application->id,
+ ]);
+
+ $env->value = 'new_value';
+ $env->save();
+
+ $env->refresh();
+ expect($env->value)->toBe('new_value');
+ expect($env->comment)->toBe('Important variable for testing');
+});
+
+test('environment variable comment is copied to preview environment', function () {
+ $env = EnvironmentVariable::create([
+ 'key' => 'TEST_VAR',
+ 'value' => 'test_value',
+ 'comment' => 'Test comment',
+ 'is_preview' => false,
+ 'resourceable_type' => Application::class,
+ 'resourceable_id' => $this->application->id,
+ ]);
+
+ // The model's booted() method should create a preview version
+ $previewEnv = EnvironmentVariable::where('key', 'TEST_VAR')
+ ->where('resourceable_id', $this->application->id)
+ ->where('is_preview', true)
+ ->first();
+
+ expect($previewEnv)->not->toBeNull();
+ expect($previewEnv->comment)->toBe('Test comment');
+});
+
+test('parseEnvFormatToArray preserves values without inline comments', function () {
+ $input = "KEY1=value1\nKEY2=value2";
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'KEY1' => ['value' => 'value1', 'comment' => null],
+ 'KEY2' => ['value' => 'value2', 'comment' => null],
+ ]);
+});
+
+test('developer view format does not break with comment-like values', function () {
+ // Values that contain # but shouldn't be treated as comments when quoted
+ $env1 = EnvironmentVariable::create([
+ 'key' => 'HASH_VAR',
+ 'value' => 'value_with_#_in_it',
+ 'comment' => 'Contains hash symbol',
+ 'resourceable_type' => Application::class,
+ 'resourceable_id' => $this->application->id,
+ ]);
+
+ expect($env1->value)->toBe('value_with_#_in_it');
+ expect($env1->comment)->toBe('Contains hash symbol');
+});
diff --git a/tests/Unit/ParseEnvFormatToArrayTest.php b/tests/Unit/ParseEnvFormatToArrayTest.php
new file mode 100644
index 000000000..303ff007d
--- /dev/null
+++ b/tests/Unit/ParseEnvFormatToArrayTest.php
@@ -0,0 +1,248 @@
+toBe([
+ 'KEY1' => ['value' => 'value1', 'comment' => null],
+ 'KEY2' => ['value' => 'value2', 'comment' => null],
+ ]);
+});
+
+test('parseEnvFormatToArray strips inline comments from unquoted values', function () {
+ $input = "NIXPACKS_NODE_VERSION=22 #needed for now\nNODE_VERSION=22";
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'NIXPACKS_NODE_VERSION' => ['value' => '22', 'comment' => 'needed for now'],
+ 'NODE_VERSION' => ['value' => '22', 'comment' => null],
+ ]);
+});
+
+test('parseEnvFormatToArray strips inline comments only when preceded by whitespace', function () {
+ $input = "KEY1=value1#nocomment\nKEY2=value2 #comment\nKEY3=value3 # comment with spaces";
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'KEY1' => ['value' => 'value1#nocomment', 'comment' => null],
+ 'KEY2' => ['value' => 'value2', 'comment' => 'comment'],
+ 'KEY3' => ['value' => 'value3', 'comment' => 'comment with spaces'],
+ ]);
+});
+
+test('parseEnvFormatToArray preserves # in quoted values', function () {
+ $input = "KEY1=\"value with # hash\"\nKEY2='another # hash'";
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'KEY1' => ['value' => 'value with # hash', 'comment' => null],
+ 'KEY2' => ['value' => 'another # hash', 'comment' => null],
+ ]);
+});
+
+test('parseEnvFormatToArray handles quoted values correctly', function () {
+ $input = "KEY1=\"quoted value\"\nKEY2='single quoted'";
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'KEY1' => ['value' => 'quoted value', 'comment' => null],
+ 'KEY2' => ['value' => 'single quoted', 'comment' => null],
+ ]);
+});
+
+test('parseEnvFormatToArray skips comment lines', function () {
+ $input = "# This is a comment\nKEY1=value1\n# Another comment\nKEY2=value2";
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'KEY1' => ['value' => 'value1', 'comment' => null],
+ 'KEY2' => ['value' => 'value2', 'comment' => null],
+ ]);
+});
+
+test('parseEnvFormatToArray skips empty lines', function () {
+ $input = "KEY1=value1\n\nKEY2=value2\n\n";
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'KEY1' => ['value' => 'value1', 'comment' => null],
+ 'KEY2' => ['value' => 'value2', 'comment' => null],
+ ]);
+});
+
+test('parseEnvFormatToArray handles values with equals signs', function () {
+ $input = 'KEY1=value=with=equals';
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'KEY1' => ['value' => 'value=with=equals', 'comment' => null],
+ ]);
+});
+
+test('parseEnvFormatToArray handles empty values', function () {
+ $input = "KEY1=\nKEY2=value";
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'KEY1' => ['value' => '', 'comment' => null],
+ 'KEY2' => ['value' => 'value', 'comment' => null],
+ ]);
+});
+
+test('parseEnvFormatToArray handles complex real-world example', function () {
+ $input = <<<'ENV'
+# Database Configuration
+DB_HOST=localhost
+DB_PORT=5432 #default postgres port
+DB_NAME="my_database"
+DB_PASSWORD='p@ssw0rd#123'
+
+# API Keys
+API_KEY=abc123 # Production key
+SECRET_KEY=xyz789
+ENV;
+
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'DB_HOST' => ['value' => 'localhost', 'comment' => null],
+ 'DB_PORT' => ['value' => '5432', 'comment' => 'default postgres port'],
+ 'DB_NAME' => ['value' => 'my_database', 'comment' => null],
+ 'DB_PASSWORD' => ['value' => 'p@ssw0rd#123', 'comment' => null],
+ 'API_KEY' => ['value' => 'abc123', 'comment' => 'Production key'],
+ 'SECRET_KEY' => ['value' => 'xyz789', 'comment' => null],
+ ]);
+});
+
+test('parseEnvFormatToArray handles the original bug scenario', function () {
+ $input = "NIXPACKS_NODE_VERSION=22 #needed for now\nNODE_VERSION=22";
+ $result = parseEnvFormatToArray($input);
+
+ // The value should be "22", not "22 #needed for now"
+ expect($result['NIXPACKS_NODE_VERSION']['value'])->toBe('22');
+ expect($result['NIXPACKS_NODE_VERSION']['value'])->not->toContain('#');
+ expect($result['NIXPACKS_NODE_VERSION']['value'])->not->toContain('needed');
+ // And the comment should be extracted
+ expect($result['NIXPACKS_NODE_VERSION']['comment'])->toBe('needed for now');
+});
+
+test('parseEnvFormatToArray handles quoted strings with spaces before hash', function () {
+ $input = "KEY1=\"value with spaces\" #comment\nKEY2=\"another value\"";
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'KEY1' => ['value' => 'value with spaces', 'comment' => 'comment'],
+ 'KEY2' => ['value' => 'another value', 'comment' => null],
+ ]);
+});
+
+test('parseEnvFormatToArray handles unquoted values with multiple hash symbols', function () {
+ $input = "KEY1=value1#not#comment\nKEY2=value2 # comment # with # hashes";
+ $result = parseEnvFormatToArray($input);
+
+ // KEY1: no space before #, so entire value is kept
+ // KEY2: space before first #, so everything from first space+# is stripped
+ expect($result)->toBe([
+ 'KEY1' => ['value' => 'value1#not#comment', 'comment' => null],
+ 'KEY2' => ['value' => 'value2', 'comment' => 'comment # with # hashes'],
+ ]);
+});
+
+test('parseEnvFormatToArray handles quoted values containing hash symbols at various positions', function () {
+ $input = "KEY1=\"#starts with hash\"\nKEY2=\"hash # in middle\"\nKEY3=\"ends with hash#\"";
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'KEY1' => ['value' => '#starts with hash', 'comment' => null],
+ 'KEY2' => ['value' => 'hash # in middle', 'comment' => null],
+ 'KEY3' => ['value' => 'ends with hash#', 'comment' => null],
+ ]);
+});
+
+test('parseEnvFormatToArray trims whitespace before comments', function () {
+ $input = "KEY1=value1 #comment\nKEY2=value2\t#comment with tab";
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'KEY1' => ['value' => 'value1', 'comment' => 'comment'],
+ 'KEY2' => ['value' => 'value2', 'comment' => 'comment with tab'],
+ ]);
+ // Values should not have trailing spaces
+ expect($result['KEY1']['value'])->not->toEndWith(' ');
+ expect($result['KEY2']['value'])->not->toEndWith("\t");
+});
+
+test('parseEnvFormatToArray preserves hash in passwords without spaces', function () {
+ $input = "PASSWORD=pass#word123\nAPI_KEY=abc#def#ghi";
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'PASSWORD' => ['value' => 'pass#word123', 'comment' => null],
+ 'API_KEY' => ['value' => 'abc#def#ghi', 'comment' => null],
+ ]);
+});
+
+test('parseEnvFormatToArray strips comments with space before hash', function () {
+ $input = "PASSWORD=passw0rd #this is secure\nNODE_VERSION=22 #needed for now";
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'PASSWORD' => ['value' => 'passw0rd', 'comment' => 'this is secure'],
+ 'NODE_VERSION' => ['value' => '22', 'comment' => 'needed for now'],
+ ]);
+});
+
+test('parseEnvFormatToArray extracts comments from quoted values followed by comments', function () {
+ $input = "KEY1=\"value\" #comment after quote\nKEY2='value' #another comment";
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'KEY1' => ['value' => 'value', 'comment' => 'comment after quote'],
+ 'KEY2' => ['value' => 'value', 'comment' => 'another comment'],
+ ]);
+});
+
+test('parseEnvFormatToArray handles empty comments', function () {
+ $input = "KEY1=value #\nKEY2=value # ";
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'KEY1' => ['value' => 'value', 'comment' => null],
+ 'KEY2' => ['value' => 'value', 'comment' => null],
+ ]);
+});
+
+test('parseEnvFormatToArray extracts multi-word comments', function () {
+ $input = 'DATABASE_URL=postgres://localhost #this is the database connection string for production';
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'DATABASE_URL' => ['value' => 'postgres://localhost', 'comment' => 'this is the database connection string for production'],
+ ]);
+});
+
+test('parseEnvFormatToArray handles mixed quoted and unquoted with comments', function () {
+ $input = "UNQUOTED=value1 #comment1\nDOUBLE=\"value2\" #comment2\nSINGLE='value3' #comment3";
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'UNQUOTED' => ['value' => 'value1', 'comment' => 'comment1'],
+ 'DOUBLE' => ['value' => 'value2', 'comment' => 'comment2'],
+ 'SINGLE' => ['value' => 'value3', 'comment' => 'comment3'],
+ ]);
+});
+
+test('parseEnvFormatToArray handles the user reported case ASD=asd #asdfgg', function () {
+ $input = 'ASD=asd #asdfgg';
+ $result = parseEnvFormatToArray($input);
+
+ expect($result)->toBe([
+ 'ASD' => ['value' => 'asd', 'comment' => 'asdfgg'],
+ ]);
+
+ // Specifically verify the comment is extracted
+ expect($result['ASD']['value'])->toBe('asd');
+ expect($result['ASD']['comment'])->toBe('asdfgg');
+ expect($result['ASD']['comment'])->not->toBeNull();
+});
From 201c9fada342f5584414164f2f7f0cde3a4425e9 Mon Sep 17 00:00:00 2001
From: Andras Bacsai <5845193+andrasbacsai@users.noreply.github.com>
Date: Tue, 18 Nov 2025 12:47:43 +0100
Subject: [PATCH 010/815] feat: limit comment field to 256 characters for
environment variables
---
.../Shared/EnvironmentVariable/Show.php | 4 +--
...comment_to_environment_variables_table.php | 4 +--
.../environment-variable/show.blade.php | 7 ++--
.../EnvironmentVariableCommentTest.php | 32 ++++++++++++++++++-
4 files changed, 38 insertions(+), 9 deletions(-)
diff --git a/app/Livewire/Project/Shared/EnvironmentVariable/Show.php b/app/Livewire/Project/Shared/EnvironmentVariable/Show.php
index 33a2c83b9..75149a0d4 100644
--- a/app/Livewire/Project/Shared/EnvironmentVariable/Show.php
+++ b/app/Livewire/Project/Shared/EnvironmentVariable/Show.php
@@ -65,7 +65,7 @@ class Show extends Component
protected $rules = [
'key' => 'required|string',
'value' => 'nullable',
- 'comment' => 'nullable|string|max:1000',
+ 'comment' => 'nullable|string|max:256',
'is_multiline' => 'required|boolean',
'is_literal' => 'required|boolean',
'is_shown_once' => 'required|boolean',
@@ -107,7 +107,7 @@ class Show extends Component
$this->validate([
'key' => 'required|string',
'value' => 'nullable',
- 'comment' => 'nullable|string|max:1000',
+ 'comment' => 'nullable|string|max:256',
'is_multiline' => 'required|boolean',
'is_literal' => 'required|boolean',
'is_shown_once' => 'required|boolean',
diff --git a/database/migrations/2025_11_17_145255_add_comment_to_environment_variables_table.php b/database/migrations/2025_11_17_145255_add_comment_to_environment_variables_table.php
index 0e17e720f..abbae3573 100644
--- a/database/migrations/2025_11_17_145255_add_comment_to_environment_variables_table.php
+++ b/database/migrations/2025_11_17_145255_add_comment_to_environment_variables_table.php
@@ -12,11 +12,11 @@ return new class extends Migration
public function up(): void
{
Schema::table('environment_variables', function (Blueprint $table) {
- $table->text('comment')->nullable();
+ $table->string('comment', 256)->nullable();
});
Schema::table('shared_environment_variables', function (Blueprint $table) {
- $table->text('comment')->nullable();
+ $table->string('comment', 256)->nullable();
});
}
diff --git a/resources/views/livewire/project/shared/environment-variable/show.blade.php b/resources/views/livewire/project/shared/environment-variable/show.blade.php
index 259f90828..80b607bd7 100644
--- a/resources/views/livewire/project/shared/environment-variable/show.blade.php
+++ b/resources/views/livewire/project/shared/environment-variable/show.blade.php
@@ -121,6 +121,7 @@
@endif
+
@else