feat: add migration methods Morphs, Uuid and Ulid and morphs for each by ahmed3mar · Pull Request #1114 · goravel/framework

ahmed3mar · 2025-07-02T16:20:05Z

📑 Description

This pull request introduces support for morph columns in polymorphic relationships, along with enhancements to UUID and ULID column handling in the database schema blueprint. It also includes the ability to configure the default morph key type and comprehensive test coverage for these new features.

Morph Column Enhancements:

Added methods to Blueprint for creating morph columns: Morphs, NullableMorphs, NumericMorphs, UuidMorphs, and UlidMorphs. These methods generate the necessary type and ID columns, along with optional indexing. (contracts/database/schema/blueprint.go, database/schema/blueprint.go - [1] [2]
Introduced morph_config.go to manage the default morph key type (int, uuid, or ulid) with utility functions like SetDefaultMorphKeyType, GetDefaultMorphKeyType, and convenience methods (MorphUsingUuids, MorphUsingUlids, MorphUsingInts). (database/schema/morph_config.go - database/schema/morph_config.goR1-R43)

UUID and ULID Column Support:

Added Uuid and Ulid methods to Blueprint for creating respective columns. (contracts/database/schema/blueprint.go, database/schema/blueprint.go - [1] [2]

Testing Enhancements:

Added extensive test cases in BlueprintTestSuite to validate the behavior of morph columns, UUID/ULID columns, and morph key type configuration. Tests cover scenarios for default, nullable, and custom key types. (database/schema/blueprint_test.go - database/schema/blueprint_test.goR736-R1081)

Mock Support for Morph Columns:

Updated mocks to include support for Morphs, NullableMorphs, and NumericMorphs methods, enabling testing of these methods in isolation. (mocks/database/schema/Blueprint.go - mocks/database/schema/Blueprint.goR2266-R2409)

Related PRs

goravel/sqlserver#30
goravel/sqlite#22
goravel/postgres#56
goravel/mysql#45

✅ Checks

Added test cases for my code

…ds to Blueprint for polymorphic relationships

…ic relationships

codecov · 2025-07-02T16:22:30Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.82%. Comparing base (01cc778) to head (e444efa).
Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1114   +/-   ##
=======================================
  Coverage   66.82%   66.82%           
=======================================
  Files         214      214           
  Lines       14104    14104           
=======================================
  Hits         9425     9425           
  Misses       4303     4303           
  Partials      376      376

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot

Pull Request Overview

This PR adds polymorphic morph column support and enhances UUID/ULID column handling in the schema blueprint, alongside configuration and test coverage updates.

Introduced Morphs, NullableMorphs, NumericMorphs, UuidMorphs, UlidMorphs methods in Blueprint
Added global morph key type configuration with convenience functions in morph_config.go
Expanded tests for new column types and morph behaviors

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
mocks/database/schema/Blueprint.go	Added mock implementations for new morph and ID methods
database/schema/morph_config.go	Introduced default morph key type config and utilities
database/schema/blueprint.go	Implemented morph and UUID/ULID column builder methods
contracts/database/schema/blueprint.go	Updated interface with new methods
database/schema/blueprint_test.go	Added tests for Uuid, Ulid, morph methods and config

Comments suppressed due to low confidence (2)

database/schema/blueprint_test.go:807

TestUuidMorphs does not include a scenario for custom index names. Consider adding a test similar to TestNumericMorphs to verify custom index naming for UuidMorphs.

func (s *BlueprintTestSuite) TestUuidMorphs() {

database/schema/morph_config.go:19

[nitpick] The error message lists valid key types but doesn't include the invalid value passed. Including the actual keyType in the error could aid debugging.

		return fmt.Errorf("morph key type must be '%s', '%s', or '%s'", MorphKeyTypeInt, MorphKeyTypeUuid, MorphKeyTypeUlid)

database/schema/blueprint.go

…tests

almas-x · 2025-07-03T23:35:09Z

If you modify any file under the contracts folder, please run the go run github.com/vektra/mockery/v2 command in the root directory to generate the mock file.

hwbrzzl

Thanks, great PR 👍

hwbrzzl · 2025-07-03T08:27:07Z

database/schema/morph_config.go

+	if keyType != MorphKeyTypeInt && keyType != MorphKeyTypeUuid && keyType != MorphKeyTypeUlid {
+		return fmt.Errorf("morph key type must be '%s', '%s', or '%s'", MorphKeyTypeInt, MorphKeyTypeUuid, MorphKeyTypeUlid)
+	}


Given we define a new MorphKeyType type, this judgment is unnecessary.

database/schema/blueprint.go

hwbrzzl · 2025-07-04T09:30:13Z

database/schema/blueprint_test.go

+	})
+}
+
+func (s *BlueprintTestSuite) TestMorphKeyTypeConfiguration() {


Could you move this test function to morph_config_test.go?

…actor MorphKeyType configuration tests

…efinitions

hwbrzzl

Left a few questions, and FYI, the merge process when adding new functions in schema will be:

Define new interface functions and implement main logic in goravel/framework
Implement new interface functions in every drivers
Merge all drver PRs first
Add test cases for the new functions in the goravel/framework::tests folder
Merge goravel/framework's PR

hwbrzzl · 2025-07-05T01:29:51Z

database/schema/blueprint.go

+func (r *Blueprint) Uuid(column string) driver.ColumnDefinition {
+	return r.createAndAddColumn("uuid", column)
+}


Please sort the function based on the first letter.

It seems not to be changed.

hwbrzzl · 2025-07-05T01:32:01Z

contracts/database/driver/grammar.go

+	// TypeUuid Create the column definition for a uuid type.
+	TypeUuid(column ColumnDefinition) string
+	// TypeUlid Create the column definition for a ulid type.
+	TypeUlid(column ColumnDefinition) string


Is TypeUlid required? Can TypeChat be used instead? I noticed that TypeUlid is char(26) in each driver.

hwbrzzl · 2025-07-05T01:33:02Z

mocks/database/schema/Blueprint.go

Please run go run github.com/vektra/mockery/v2 to regenerate this file.

hwbrzzl · 2025-07-05T01:37:59Z

database/schema/blueprint_test.go

Great tests 👍

… Ulid methods in Blueprint for column definitions

…eter for column definition

…ameters for column definitions

… Ulid method to use constant for default length

hwbrzzl

Great 👍 Please add test cases in tests/query_test.go for the new feature.

hwbrzzl · 2025-07-07T01:05:08Z

database/schema/blueprint.go

+	columnImpl := r.createAndAddColumn("char", column)
+	columnImpl.length = &defaultLength
+
+	return columnImpl


Char can be called here directly.

hwbrzzl · 2025-07-07T01:06:30Z

database/schema/blueprint.go

+func (r *Blueprint) Uuid(column string) driver.ColumnDefinition {
+	return r.createAndAddColumn("uuid", column)
+}


It seems not to be changed.

database/schema/blueprint.go

…nt.go for improved organization

…sistency and clarity

hwbrzzl · 2025-07-09T09:30:20Z

Hi @ahmed3mar Thanks for your great PR, and FYI, v1.16 is going to be released in about one/two weeks. I think this PR is almost finished, it only lacks test cases in the tests folder. It would be great if it could be merged before the release.

…ionships - Introduced UuidEntity and UlidEntity models for testing UUID and ULID columns. - Added MorphableEntity, UuidMorphableEntity, and UlidMorphableEntity models for testing polymorphic relationships. - Implemented comprehensive test cases for UUID and ULID column operations, including creation, retrieval, and format validation. - Enhanced tests for morphable relationships, ensuring correct functionality across different entity types.

hwbrzzl

Great 👍 but CI failed, you can only test postgres driver locally, the speed will be faster: https://github.com/goravel/framework/blob/master/tests/query.go#L131-L143

hwbrzzl · 2025-07-09T10:30:53Z

tests/query_test.go

+		}
+
+		s.Run(fmt.Sprintf("TestUuidColumn_%s", driver), func() {
+			query.CreateTable(TestTableUuidEntities)


It's unnecessary, the table will be created here https://github.com/goravel/framework/blob/master/tests/query_test.go#L44

hwbrzzl · 2025-07-09T10:39:57Z

tests/query_test.go

The test cases only covered the create and Find flows, we'd better add some test cases for the Relationship query: facades.Orm().Query().With({morphable_table}).Fine(&user).

tests/query_test.go

hwbrzzl

Amazing job 💯 Thanks!

cursor

Bug: Race Condition in Global Morph Key Type

The global variable defaultMorphKeyType is subject to race conditions. Multiple functions (e.g., SetDefaultMorphKeyType, GetDefaultMorphKeyType, MorphUsingUuids) access and modify this variable without any synchronization. This lack of protection can lead to inconsistent reads and writes, causing data races when multiple goroutines interact with the morph key type configuration concurrently.

database/schema/morph_config.go#L11-L37

framework/database/schema/morph_config.go

Lines 11 to 37 in e444efa

    
           var defaultMorphKeyType MorphKeyType = MorphKeyTypeInt 
        
           // SetDefaultMorphKeyType sets the default morph key type 
        
           func SetDefaultMorphKeyType(keyType MorphKeyType) { 
        
           	defaultMorphKeyType = keyType 
        
           } 
        
           // GetDefaultMorphKeyType returns the current default morph key type 
        
           func GetDefaultMorphKeyType() MorphKeyType { 
        
           	return defaultMorphKeyType 
        
           } 
        
           // MorphUsingUuids sets the default morph key type to UUID 
        
           func MorphUsingUuids() { 
        
           	defaultMorphKeyType = MorphKeyTypeUuid 
        
           } 
        
           // MorphUsingUlids sets the default morph key type to ULID 
        
           func MorphUsingUlids() { 
        
           	defaultMorphKeyType = MorphKeyTypeUlid 
        
           } 
        
           // MorphUsingInts sets the default morph key type to int (default) 
        
           func MorphUsingInts() { 
        
           	defaultMorphKeyType = MorphKeyTypeInt 
        
           }

Fix in Cursor • Fix in Web

BugBot free trial expires on July 22, 2025
You have used $0.00 of your $1.00 spend limit so far. Manage your spend limit in the Cursor dashboard.

Was this report helpful? Give feedback by reacting with 👍 or 👎

hwbrzzl · 2025-07-22T14:19:09Z

Hey @ahmed3mar, thanks for your amazing PRs. Congratulations on getting a v1.16 commemorative T-shirt. I sent a message on Discord, please contact me.

ahmed3mar added 3 commits July 2, 2025 18:19

feat: add Uuid method to Blueprint for UUID column creation

0334bc7

feat: add Morphs, NullableMorphs, NumericMorphs, and UuidMorphs metho…

2b8ab29

…ds to Blueprint for polymorphic relationships

feat: add ULID support to Blueprint for column creation and polymorph…

5536010

…ic relationships

Copilot AI review requested due to automatic review settings July 2, 2025 16:20

ahmed3mar requested a review from a team as a code owner July 2, 2025 16:20

Copilot AI reviewed Jul 2, 2025

View reviewed changes

database/schema/blueprint.go Outdated Show resolved Hide resolved

ahmed3mar added 2 commits July 3, 2025 17:20

refactor: simplify morph index creation in Blueprint methods

794913e

refactor: handle return value of SetDefaultMorphKeyType in Blueprint …

e61772d

…tests

hwbrzzl reviewed Jul 4, 2025

View reviewed changes

ahmed3mar added 2 commits July 5, 2025 02:36

feat: add support for custom index names in UuidMorphs method and ref…

6875ea1

…actor MorphKeyType configuration tests

feat: add TypeUuid and TypeUlid methods to SchemaGrammar for column d…

4d91df6

…efinitions

hwbrzzl reviewed Jul 5, 2025

View reviewed changes

ahmed3mar added 7 commits July 5, 2025 14:23

refactor: remove TypeUlid from SchemaGrammar and reintroduce Uuid and…

cd7eca1

… Ulid methods in Blueprint for column definitions

feat: update Ulid method in Blueprint to accept optional length param…

4bf490f

…eter for column definition

feat: enhance Ulid method in Blueprint to support variadic length par…

ed40080

…ameters for column definitions

refactor: streamline SetDefaultMorphKeyType usage in tests and update…

3ef6e1f

… Ulid method to use constant for default length

rebuild

93cf0bc

update test dependeancy

9a64532

Merge branch 'goravel:master' into feature/support-uuid

466eb93

hwbrzzl reviewed Jul 7, 2025

View reviewed changes

sort enhance

62aa57e

hwbrzzl reviewed Jul 7, 2025

View reviewed changes

database/schema/blueprint.go Outdated Show resolved Hide resolved

ahmed3mar added 2 commits July 7, 2025 13:45

refactor: move createMorphIndex function to a new location in bluepri…

3aac4c5

…nt.go for improved organization

refactor: reorganize Uuid and Ulid morph methods in Blueprint for con…

80ec50a

…sistency and clarity

fix conflicts

1a9861a

ahmed3mar added 3 commits July 9, 2025 12:36

fix conflicts

8597071

fix test

a88b10d

hwbrzzl reviewed Jul 9, 2025

View reviewed changes

fix test

91d1ef5

hwbrzzl reviewed Jul 9, 2025

View reviewed changes

tests/query_test.go Outdated Show resolved Hide resolved

Update tests/query_test.go

e444efa

hwbrzzl approved these changes Jul 9, 2025

View reviewed changes

cursor bot reviewed Jul 9, 2025

View reviewed changes

hwbrzzl merged commit fe8bfb1 into goravel:master Jul 9, 2025
14 of 15 checks passed

ahmed3mar deleted the feature/support-uuid branch July 9, 2025 15:09


	var defaultMorphKeyType MorphKeyType = MorphKeyTypeInt

	// SetDefaultMorphKeyType sets the default morph key type
	func SetDefaultMorphKeyType(keyType MorphKeyType) {
	defaultMorphKeyType = keyType
	}

	// GetDefaultMorphKeyType returns the current default morph key type
	func GetDefaultMorphKeyType() MorphKeyType {
	return defaultMorphKeyType
	}

	// MorphUsingUuids sets the default morph key type to UUID
	func MorphUsingUuids() {
	defaultMorphKeyType = MorphKeyTypeUuid
	}

	// MorphUsingUlids sets the default morph key type to ULID
	func MorphUsingUlids() {
	defaultMorphKeyType = MorphKeyTypeUlid
	}

	// MorphUsingInts sets the default morph key type to int (default)
	func MorphUsingInts() {
	defaultMorphKeyType = MorphKeyTypeInt
	}

Conversation

ahmed3mar commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📑 Description

Morph Column Enhancements:

UUID and ULID Column Support:

Testing Enhancements:

Mock Support for Morph Columns:

Related PRs

✅ Checks

Uh oh!

codecov bot commented Jul 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

almas-x commented Jul 3, 2025

Uh oh!

hwbrzzl left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hwbrzzl left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

hwbrzzl left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hwbrzzl commented Jul 9, 2025

Uh oh!

hwbrzzl left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hwbrzzl left a comment

Choose a reason for hiding this comment

Uh oh!

cursor bot left a comment

Choose a reason for hiding this comment

Bug: Race Condition in Global Morph Key Type

Uh oh!

Uh oh!

hwbrzzl commented Jul 22, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

ahmed3mar commented Jul 2, 2025 •

edited

Loading

codecov bot commented Jul 2, 2025 •

edited

Loading