New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Hyrax::CollectionType uses a custom GlobalId scheme #4696

Open

no-reply opened this issue Dec 31, 2020 · 1 comment

Labels

Milestone

Contributor

no-reply commented Dec 31, 2020

Descriptive summary

CollectionType#gid has custom behavior that conflicts with GlobalID's typical supported interface. We should bring it in line.

ctype =  Hyrax::CollectionType.create(title: 'my type')

# the usual interface
ctype.to_global_id # => #<GlobalID:0x00005597abc31098 @uri=#<URI::GID gid://dassie/Hyrax::CollectionType/2>>
GlobalID::Locator.locate ctype.to_global_id # =>  #<Hyrax::CollectionType:0x...
GlobalID::Locator.locate ctype.to_global_id.to_s # =>  #<Hyrax::CollectionType:0x...

# Hyrax::CollectionType (as used by collection, etc...
ctype.gid # =>  ctype.gid=> "gid://dassie/hyrax-collectiontype/2"
GlobalID::Locator.locate ctype.gid #NameError: wrong constant name hyrax-collectiontype
Hyrax::CollectionType.find_by_gid(ctype.gid) # => #<Hyrax::CollectionType:0x...
Hyrax::CollectionType.find_by_gid('gid://dassie/just-making-some-stuff-up/2') # => #<Hyrax::CollectionType:0x0

we should realign so all users of #gid and .find_by_gid get correct global id syntax.

The text was updated successfully, but these errors were encountered:

no-reply pushed a commit that referenced this issue


          make CollectionType#find_by_gid work with correct global id format

4a7f99c

this begins to address #4696 by allowing `CollectionType#find_by_gid` to find
"real" GlobalID objects and matching strings.

to move away from the old custom format, we'll need to provide a data
migration/rake task that can fix existing references.

no-reply mentioned this issue

make CollectionType#find_by_gid work with correct global id format #4701

Merged

no-reply pushed a commit that referenced this issue


          make CollectionType#find_by_gid work with correct global id format

2fc2c3c

this begins to address #4696 by allowing `CollectionType#find_by_gid` to find
"real" GlobalID objects and matching strings.

to move away from the old custom format, we'll need to provide a data
migration/rake task that can fix existing references.

no-reply pushed a commit that referenced this issue


          make CollectionType#find_by_gid work with correct global id format

2a8b9ee

this begins to address #4696 by allowing `CollectionType#find_by_gid` to find
"real" GlobalID objects and matching strings.

to move away from the old custom format, we'll need to provide a data
migration/rake task that can fix existing references.

no-reply pushed a commit that referenced this issue


          add a rake task to update collection references to collection types

as part of #4696: since we're deprecating our older semi-custom global id
syntax, we need to be able to support applications updating their collections.

the rake task `hyrax:collections:update_collection_type_global_ids` provides a
way to do this, and is a non-destructive if collections all use the standard
syntax.

note that this task may create substantial load, even if all collections are
already up to date; so it shouldn't be run repeatedly.

no-reply pushed a commit that referenced this issue


          make CollectionType#find_by_gid work with correct global id format

3031e39

this begins to address #4696 by allowing `CollectionType#find_by_gid` to find
"real" GlobalID objects and matching strings.

to move away from the old custom format, we'll need to provide a data
migration/rake task that can fix existing references.

no-reply pushed a commit that referenced this issue


          add a rake task to update collection references to collection types

97093fe

as part of #4696: since we're deprecating our older semi-custom global id
syntax, we need to be able to support applications updating their collections.

the rake task `hyrax:collections:update_collection_type_global_ids` provides a
way to do this, and is a non-destructive if collections all use the standard
syntax.

note that this task may create substantial load, even if all collections are
already up to date; so it shouldn't be run repeatedly.

no-reply pushed a commit that referenced this issue


          make CollectionType#find_by_gid work with correct global id format

b5c6987

this begins to address #4696 by allowing `CollectionType#find_by_gid` to find
"real" GlobalID objects and matching strings.

to move away from the old custom format, we'll need to provide a data
migration/rake task that can fix existing references.

no-reply pushed a commit that referenced this issue


          add a rake task to update collection references to collection types

00bddc9

as part of #4696: since we're deprecating our older semi-custom global id
syntax, we need to be able to support applications updating their collections.

the rake task `hyrax:collections:update_collection_type_global_ids` provides a
way to do this, and is a non-destructive if collections all use the standard
syntax.

note that this task may create substantial load, even if all collections are
already up to date; so it shouldn't be run repeatedly.

no-reply pushed a commit that referenced this issue


          make CollectionType#find_by_gid work with correct global id format

2d51041

this begins to address #4696 by allowing `CollectionType#find_by_gid` to find
"real" GlobalID objects and matching strings.

to move away from the old custom format, we'll need to provide a data
migration/rake task that can fix existing references.

no-reply pushed a commit that referenced this issue


          add a rake task to update collection references to collection types

2e3c6f1

as part of #4696: since we're deprecating our older semi-custom global id
syntax, we need to be able to support applications updating their collections.

the rake task `hyrax:collections:update_collection_type_global_ids` provides a
way to do this, and is a non-destructive if collections all use the standard
syntax.

note that this task may create substantial load, even if all collections are
already up to date; so it shouldn't be run repeatedly.

no-reply pushed a commit that referenced this issue


          make CollectionType#find_by_gid work with correct global id format

this begins to address #4696 by allowing `CollectionType#find_by_gid` to find
"real" GlobalID objects and matching strings.

to move away from the old custom format, we'll need to provide a data
migration/rake task that can fix existing references.

no-reply added this to the 3.x series milestone

no-reply added the technical debt label

no-reply pushed a commit that referenced this issue


          add a rake task to update collection references to collection types

e9d429c

as part of #4696: since we're deprecating our older semi-custom global id
syntax, we need to be able to support applications updating their collections.

the rake task `hyrax:collections:update_collection_type_global_ids` provides a
way to do this, and is a non-destructive if collections all use the standard
syntax.

note that this task may create substantial load, even if all collections are
already up to date; so it shouldn't be run repeatedly.

no-reply pushed a commit that referenced this issue


          make CollectionType#find_by_gid work with correct global id format

d8157d2

this begins to address #4696 by allowing `CollectionType#find_by_gid` to find
"real" GlobalID objects and matching strings.

to move away from the old custom format, we'll need to provide a data
migration/rake task that can fix existing references.

Contributor Author

no-reply commented Mar 18, 2021

the next step on this is to provide a data migration task to update existing references, then code to handle the custom format can be removed in the next major release.

no-reply mentioned this issue

Refactor CollectionTypes to use Default GlobalID implementation #4066

Closed

no-reply mentioned this issue

build CollectionType GlobalID for Admin Sets without db lookup #5209

Closed

no-reply pushed a commit to samvera/bulkrax that referenced this issue


          use the GlobalID library tooling to determine global id

952a818

the old `#gid` method was weird and breaking for users expecting things to work
with `GlobalID` tools: samvera/hyrax#4696

Hyrax has provided a mechanism for updating "gid" references since the 3.0 line,
and will drop `#gid` in 5.0.0. use `#to_global_id` to get global ids instead.

no-reply mentioned this issue

use the GlobalID library tooling to determine global id samvera/bulkrax#869

Merged

no-reply pushed a commit to samvera/bulkrax that referenced this issue


          use the GlobalID library tooling to determine global id

a5cc8c2

the old `#gid` method was weird and breaking for users expecting things to work
with `GlobalID` tools: samvera/hyrax#4696

Hyrax has provided a mechanism for updating "gid" references since the 3.0 line,
and will drop `#gid` in 5.0.0. use `#to_global_id` to get global ids instead.

dunn pushed a commit to samvera/bulkrax that referenced this issue


          use the GlobalID library tooling to determine global id

d8a1237

the old `#gid` method was weird and breaking for users expecting things to work
with `GlobalID` tools: samvera/hyrax#4696

Hyrax has provided a mechanism for updating "gid" references since the 3.0 line,
and will drop `#gid` in 5.0.0. use `#to_global_id` to get global ids instead.

jeremyf pushed a commit to samvera/bulkrax that referenced this issue


          use the GlobalID library tooling to determine global id (#869)

75e3d26

the old `#gid` method was weird and breaking for users expecting things to work
with `GlobalID` tools: samvera/hyrax#4696

Hyrax has provided a mechanism for updating "gid" references since the 3.0 line,
and will drop `#gid` in 5.0.0. use `#to_global_id` to get global ids instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment