RegistryOfDialects (ROD) -> RegistryOfLanguageVarieties (ROLV) (#3269)

rdonigian · CarsonF · web-flow · commit 60d8888b32d4 · 2024-07-31T11:12:55.000-05:00
Co-authored-by: Carson Full &lt;carson_full@tsco.org&gt;
diff --git a/dbschema/language.esdl b/dbschema/language.esdl
@@ -40,7 +40,7 @@ module default {
       default := false;
     }
     
-    registryOfDialectsCode: str {
+    registryOfLanguageVarietiesCode: str {
       constraint exclusive;
       constraint regexp(r'^[0-9]{5}$');
     }
diff --git a/dbschema/migrations/00012-m1ah2np.edgeql b/dbschema/migrations/00012-m1ah2np.edgeql
diff --git a/dbschema/seeds/005.languages.edgeql b/dbschema/seeds/005.languages.edgeql
@@ -4,7 +4,7 @@ with
       "name": "English",
       "displayNamePronunciation": "[ENG-lish]",
       "sensitivity": "Low",
-      "registryOfDialectsCode": "00120",
+      "registryOfLanguageVarietiesCode": "00120",
       "populationOverride": 100000,
       "ethnologue": {
         "code": "eng",
@@ -15,7 +15,7 @@ with
       "name": "Quenya",
       "displayNamePronunciation": "[KWEN-ya]",
       "sensitivity": "Medium",
-      "registryOfDialectsCode": "99931",
+      "registryOfLanguageVarietiesCode": "99931",
       "populationOverride": 500000,
       "leastOfThese": true,
       "ethnologue": {
@@ -27,7 +27,7 @@ with
       "name": "Sindarin",
       "displayNamePronunciation": "[sin-DAR-in]",
       "sensitivity": "Medium",
-      "registryOfDialectsCode": "12345",
+      "registryOfLanguageVarietiesCode": "12345",
       "hasExternalFirstScripture": true,
       "ethnologue": {
         "code": "sdn",
@@ -39,7 +39,7 @@ with
       "name": "Khuzdul",
       "displayNamePronunciation": "[KUHZ-dul]",
       "sensitivity": "High",
-      "registryOfDialectsCode": "22225",
+      "registryOfLanguageVarietiesCode": "22225",
       "leastOfThese": true,
       "hasExternalFirstScripture": true,
       "ethnologue": {
@@ -51,7 +51,7 @@ with
       "name": "Westron",
       "displayNamePronunciation": "[WEST-ron]",
       "sensitivity": "Low",
-      "registryOfDialectsCode": "78910",
+      "registryOfLanguageVarietiesCode": "78910",
       "isSignLanguage": true,
       "signLanguageCode": "WT10",
       "ethnologue": {
@@ -72,7 +72,7 @@ with
           displayNamePronunciation := <str>language['displayNamePronunciation'],
           ownSensitivity := <Sensitivity>json_get(language, 'sensitivity'),
           isDialect := <bool>json_get(language, 'isDialect') ?? false,
-          registryOfDialectsCode := <str>json_get(language, 'registryOfDialectsCode'),
+          registryOfLanguageVarietiesCode := <str>json_get(language, 'registryOfLanguageVarietiesCode'),
           leastOfThese := <bool>json_get(language, 'leastOfThese') ?? false,
           isSignLanguage := exists json_get(language, 'signLanguageCode'),
           signLanguageCode := <str>json_get(language, 'signLanguageCode'),
diff --git a/src/components/authorization/policies/by-role/consultant-manager.policy.ts b/src/components/authorization/policies/by-role/consultant-manager.policy.ts
@@ -11,7 +11,11 @@ import * as Consultant from './consultant.policy';
   r.Language.read.specifically(
     (p) =>
       p
-        .many('registryOfDialectsCode', 'signLanguageCode', 'locations')
+        .many(
+          'registryOfLanguageVarietiesCode',
+          'signLanguageCode',
+          'locations',
+        )
         .whenAny(member, sensMediumOrLower).read,
   ),
   r.LanguageEngagement.edit.specifically((p) => [
diff --git a/src/components/authorization/policies/by-role/financial-analyst.policy.ts b/src/components/authorization/policies/by-role/financial-analyst.policy.ts
@@ -37,7 +37,7 @@ export const projectTransitions = () =>
     r.FundingAccount.read,
     r.Language.read.specifically((p) => [
       p.locations.when(sensOnlyLow).read,
-      p.many('registryOfDialectsCode', 'signLanguageCode').none,
+      p.many('registryOfLanguageVarietiesCode', 'signLanguageCode').none,
     ]),
     r.Organization.read.create.whenAny(member, sensMediumOrLower).edit,
     r.Partner.read.create
diff --git a/src/components/authorization/policies/by-role/fundraising.policy.ts b/src/components/authorization/policies/by-role/fundraising.policy.ts
@@ -4,7 +4,7 @@ import { member, Policy, Role, sensMediumOrLower } from '../util';
 @Policy(Role.Fundraising, (r) => [
   r.EthnologueLanguage.whenAny(member, sensMediumOrLower).read,
   r.Language.read.specifically((p) => [
-    p.registryOfDialectsCode.whenAny(member, sensMediumOrLower).read,
+    p.registryOfLanguageVarietiesCode.whenAny(member, sensMediumOrLower).read,
     p.signLanguageCode.whenAny(member, sensMediumOrLower).read,
     p.locations.whenAny(member, sensMediumOrLower).read,
   ]),
diff --git a/src/components/authorization/policies/by-role/intern.policy.ts b/src/components/authorization/policies/by-role/intern.policy.ts
@@ -13,7 +13,7 @@ import { inherit, member, Policy, Role } from '../util';
         'leastOfThese',
         'leastOfTheseReason',
         'name',
-        'registryOfDialectsCode',
+        'registryOfLanguageVarietiesCode',
         'signLanguageCode',
         'sponsorEstimatedEndDate',
       ).none,
diff --git a/src/components/authorization/policies/by-role/investor-common.policy.ts b/src/components/authorization/policies/by-role/investor-common.policy.ts
@@ -21,7 +21,7 @@ import {
   r.FieldRegion.read,
   r.FieldZone.read,
   r.Language.read.specifically((p) => [
-    p.registryOfDialectsCode.when(sensOnlyLow).read,
+    p.registryOfLanguageVarietiesCode.when(sensOnlyLow).read,
     p.signLanguageCode.when(sensOnlyLow).read,
     p.locations.whenAny(member, sensOnlyLow).read,
   ]),
diff --git a/src/components/authorization/policies/by-role/mentor.policy.ts b/src/components/authorization/policies/by-role/mentor.policy.ts
@@ -13,7 +13,7 @@ import { inherit, member, Policy, Role } from '../util';
         'leastOfThese',
         'leastOfTheseReason',
         'name',
-        'registryOfDialectsCode',
+        'registryOfLanguageVarietiesCode',
         'signLanguageCode',
         'sponsorEstimatedEndDate',
       ).none,
diff --git a/src/components/authorization/policies/by-role/staff-member.policy.ts b/src/components/authorization/policies/by-role/staff-member.policy.ts
@@ -13,7 +13,7 @@ import { inherit, Policy, Role, sensOnlyLow } from '../util';
   r.FundingAccount.read,
   r.Language.read.specifically((p) => [
     p.locations.when(sensOnlyLow).read,
-    p.registryOfDialectsCode.none,
+    p.registryOfLanguageVarietiesCode.none,
     p.signLanguageCode.none,
   ]),
   r.Organization.read.specifically((p) => [
diff --git a/src/components/language/dto/create-language.dto.ts b/src/components/language/dto/create-language.dto.ts
@@ -64,11 +64,19 @@ export abstract class CreateLanguage {
   @IsPositive()
   readonly populationOverride: number | null;
 
-  @NameField({ nullable: true })
+  @NameField({
+    nullable: true,
+    deprecationReason: 'Use registryOfLanguageVarietiesCode instead',
+  })
   @ExactLength(5)
   @IsNumberString()
   readonly registryOfDialectsCode?: string | null;
 
+  @NameField({ nullable: true })
+  @ExactLength(5)
+  @IsNumberString()
+  readonly registryOfLanguageVarietiesCode?: string | null;
+
   @Field({ nullable: true })
   readonly leastOfThese: boolean = false;
 
diff --git a/src/components/language/dto/language.dto.ts b/src/components/language/dto/language.dto.ts
@@ -134,13 +134,13 @@ export class Language extends Interfaces {
 
   @Field({
     description: stripIndent`
-      Registry of Dialects Code.
-      5 digit number including leading zeros.
-      https://globalrecordings.net/en/rod
+      Harvest Information System's (HIS) Registry Of Language Varieties' (ROLV) code.
+      A 5 digit number including leading zeros.
+      https://globalrecordings.net/en/rolv
     `,
   })
-  @DbUnique('RegistryOfDialectsCode')
-  readonly registryOfDialectsCode: SecuredStringNullable;
+  @DbUnique('RegistryOfLanguageVarietiesCode')
+  readonly registryOfLanguageVarietiesCode: SecuredStringNullable;
 
   // consider making object
   @Field({
diff --git a/src/components/language/dto/list-language.dto.ts b/src/components/language/dto/list-language.dto.ts
@@ -73,9 +73,13 @@ export abstract class LanguageFilters {
 
   @Field({
     nullable: true,
+    deprecationReason: 'Use `registryOfLanguageVarietiesCode` instead',
   })
   readonly registryOfDialectsCode?: string;
 
+  @Field({ nullable: true })
+  readonly registryOfLanguageVarietiesCode?: string;
+
   readonly partnerId?: ID;
 
   @FilterField(() => EthnologueLanguageFilters)
diff --git a/src/components/language/dto/update-language.dto.ts b/src/components/language/dto/update-language.dto.ts
@@ -70,11 +70,19 @@ export abstract class UpdateLanguage {
   @IsPositive()
   readonly populationOverride?: number | null;
 
-  @NameField({ nullable: true })
+  @NameField({
+    nullable: true,
+    deprecationReason: 'Use registryOfLanguageVarietiesCode instead',
+  })
   @ExactLength(5)
   @IsNumberString()
   readonly registryOfDialectsCode?: string | null;
 
+  @NameField({ nullable: true })
+  @ExactLength(5)
+  @IsNumberString()
+  readonly registryOfLanguageVarietiesCode?: string | null;
+
   @Field({ nullable: true })
   readonly leastOfThese?: boolean;
 
diff --git a/src/components/language/ethnologue-language/ethnologue-language.repository.ts b/src/components/language/ethnologue-language/ethnologue-language.repository.ts
@@ -35,7 +35,7 @@ export class EthnologueLanguageRepository extends DtoRepository(
           simpleSwitch(e.label, {
             LanguageName: 'name',
             LanguageDisplayName: 'displayName',
-            RegistryOfDialectsCode: `registryOfDialectsCode`,
+            RegistryOfLanguageVarietiesCode: 'registryOfLanguageVarietiesCode',
           }) ?? e.label;
         throw new DuplicateException(
           `language.${prop}`,
diff --git a/src/components/language/language.module.ts b/src/components/language/language.module.ts
@@ -13,6 +13,7 @@ import { LanguageLoader } from './language.loader';
 import { LanguageRepository } from './language.repository';
 import { LanguageResolver } from './language.resolver';
 import { LanguageService } from './language.service';
+import { RegistryOfDialectToRegistryOfLanguageVarietiesMigration } from './migrations/rename-rod-to-rolv.migration';
 
 @Module({
   imports: [
@@ -29,6 +30,7 @@ import { LanguageService } from './language.service';
     splitDb(LanguageRepository, LanguageEdgeDBRepository),
     LanguageLoader,
     InternalFirstScriptureResolver,
+    RegistryOfDialectToRegistryOfLanguageVarietiesMigration,
   ],
   exports: [LanguageService],
 })
diff --git a/src/components/language/language.repository.ts b/src/components/language/language.repository.ts
@@ -70,7 +70,8 @@ export class LanguageRepository extends DtoRepository<
       sensitivity: input.sensitivity,
       isDialect: input.isDialect,
       populationOverride: input.populationOverride,
-      registryOfDialectsCode: input.registryOfDialectsCode,
+      registryOfLanguageVarietiesCode:
+        input.registryOfLanguageVarietiesCode ?? input.registryOfDialectsCode,
       leastOfThese: input.leastOfThese,
       leastOfTheseReason: input.leastOfTheseReason,
       displayNamePronunciation: input.displayNamePronunciation,
@@ -106,7 +107,7 @@ export class LanguageRepository extends DtoRepository<
           simpleSwitch(e.label, {
             LanguageName: 'name',
             LanguageDisplayName: 'displayName',
-            RegistryOfDialectsCode: `registryOfDialectsCode`,
+            RegistryOfLanguageAndVariantsCode: `registryOfLanguageAndVariantsCode`,
           }) ?? e.label;
         throw new DuplicateException(
           `language.${prop}`,
@@ -290,7 +291,10 @@ export const languageFilters = filter.define(() => LanguageFilters, {
   leastOfThese: filter.propVal(),
   isSignLanguage: filter.propVal(),
   isDialect: filter.propVal(),
-  registryOfDialectsCode: filter.propPartialVal(),
+  registryOfDialectsCode: filter.propPartialVal(
+    'registryOfLanguageVarietiesCode',
+  ),
+  registryOfLanguageVarietiesCode: filter.propPartialVal(),
   partnerId: filter.pathExists((id) => [
     node('node'),
     relation('in', '', 'language', ACTIVE),
diff --git a/src/components/language/language.resolver.ts b/src/components/language/language.resolver.ts
@@ -18,6 +18,7 @@ import {
   LoggedInSession,
   SecuredDate,
   SecuredIntNullable,
+  SecuredStringNullable,
   Session,
   viewOfChangeset,
 } from '~/common';
@@ -99,6 +100,13 @@ export class LanguageResolver {
     };
   }
 
+  @ResolveField(() => SecuredStringNullable, {
+    deprecationReason: 'Use `registryOfLanguageVarieties` instead',
+  })
+  registryOfDialectsCode(@Parent() language: Language): SecuredStringNullable {
+    return language.registryOfLanguageVarietiesCode;
+  }
+
   @ResolveField()
   firstScripture(@Parent() language: Language): SecuredFirstScripture {
     if (!language.hasExternalFirstScripture.canRead) {
diff --git a/src/components/language/language.service.ts b/src/components/language/language.service.ts
@@ -86,9 +86,14 @@ export class LanguageService {
     if (input.hasExternalFirstScripture) {
       await this.verifyExternalFirstScripture(input.id);
     }
+    const { registryOfDialectsCode, ...props } = input;
 
     const language = await this.repo.readOne(input.id, session, view);
-    const changes = this.repo.getActualChanges(language, input);
+    const changes = this.repo.getActualChanges(language, {
+      ...props,
+      registryOfLanguageVarietiesCode:
+        props.registryOfLanguageVarietiesCode ?? registryOfDialectsCode,
+    });
     this.privileges.for(session, Language, language).verifyChanges(changes);
 
     const { ethnologue, ...simpleChanges } = changes;
diff --git a/src/components/language/migrations/rename-rod-to-rolv.migration.ts b/src/components/language/migrations/rename-rod-to-rolv.migration.ts
@@ -0,0 +1,32 @@
+import { node, relation } from 'cypher-query-builder';
+import { BaseMigration, Migration } from '~/core/database';
+import { collect, variable } from '~/core/database/query';
+
+@Migration('2024-07-30T13:02:07')
+export class RegistryOfDialectToRegistryOfLanguageVarietiesMigration extends BaseMigration {
+  async up() {
+    await this.db
+      .query()
+      .match([
+        node('', 'Language'),
+        relation('out', 'rel', 'registryOfDialectsCode'),
+        node('', 'Property'),
+      ])
+      .with(collect('rel').as('rels'))
+      .call('apoc.refactor.rename.type', [
+        variable('"registryOfDialectsCode"'),
+        variable('"registryOfLanguageVarietiesCode"'),
+        variable('rels'),
+      ])
+      .yield('total')
+      .return('total')
+      .executeAndLogStats();
+
+    await this.db
+      .query()
+      .match(node('node', 'RegistryOfDialectsCode'))
+      .setLabels({ node: 'RegistryOfLanguageVarietiesCode' })
+      .removeLabels({ node: 'RegistryOfDialectsCode' })
+      .executeAndLogStats();
+  }
+}
diff --git a/test/utility/create-language.ts b/test/utility/create-language.ts
@@ -28,7 +28,7 @@ export async function createLanguage(
     isDialect: faker.datatype.boolean(),
     // this represents the largest number that is less than the 32-bit max for GraphQL
     populationOverride: faker.number.int({ max: 2147483647 }),
-    registryOfDialectsCode: faker.number
+    registryOfLanguageVarietiesCode: faker.number
       .int({ min: 10000, max: 99999 })
       .toString(),
     leastOfThese: faker.datatype.boolean(),
diff --git a/test/utility/fragments.ts b/test/utility/fragments.ts
@@ -203,7 +203,7 @@ export const language = gql`
       canEdit
       canRead
     }
-    registryOfDialectsCode {
+    registryOfLanguageVarietiesCode {
       value
       canEdit
       canRead

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ module default {`
`40`	`40`	`default := false;`
`41`	`41`	`}`
`42`	`42`
`43`		`- registryOfDialectsCode: str {`
	`43`	`+ registryOfLanguageVarietiesCode: str {`
`44`	`44`	`constraint exclusive;`
`45`	`45`	`constraint regexp(r'^[0-9]{5}$');`
`46`	`46`	`}`