defaultValue should work with default locale of space if locale doesn't exist

[sayjeyhi]

Hi,

When working with multiple spaces with different locales, having same migration files ends up is a situation when we have a migration to run for space A with locale z and space B can run it because it doesn't have locale z.

sample:

field.defaultValue({ 'en-GB': 'primary' })

Error:

Cannot set default value for locale "en-GB" on field "XXXX". The locale does not exist.

Proposal:

• accept a default locale on runMigration method and handle this.
• change the defaultValue method to have some generic approach

[AlanSl]

Agreed, the migrations API shouldn't required hardcoded locales.

Even better would be if defaultValue takes one of either a keyed object like now, or, a function that runs on each locale in the space, passing each locale in as an argument each time it runs, a bit like deriveEntryForLocale or transformEntryForLocale do, e.g., for fields that don't need localised defaults:

// Sets it as 'primary' for every locale, e.g. for system value like a component variant from a preset list
field.defaultValue((_locale) => 'primary'))

...or, for fields that need localised defaults:

import someTranslations from './translations.json'

// Localised default values for the languages this app uses from a global source with all supported languages  
field.defaultValue((locale) => someTranslations.widget.label[locale]))

The only workaround I can think of in the meantime is to connect to the Management API at the same time as running the Migrations API (or use makeRequest to get them from the /locales endpoint), get the list of locales from the Management API, and build an object based on that; but that feels hacky.