json-rest-api 1.0.29 → 2.1.0

package/tests/id-normalization.test.js

@@ -1,444 +0,0 @@
-import { describe, it, before, after, beforeEach } from 'node:test'
-import assert from 'node:assert/strict'
-import knexLib from 'knex'
-
-import {
-  cleanTables,
-  createJsonApiDocument,
-  validateJsonApiStructure
-} from './helpers/test-utils.js'
-import { storageMode } from './helpers/storage-mode.js'
-import { createIdNormalizationApi } from './fixtures/api-configs.js'
-
-const knex = knexLib({
-  client: 'better-sqlite3',
-  connection: {
-    filename: ':memory:'
-  },
-  useNullAsDefault: true
-})
-
-let defaultApi
-let overrideApi
-
-const getTenantId = (api) => api?.anyapi?.tenantId || storageMode.defaultTenant
-
-const loadStoredResourceRow = async ({ api, resource, tableName, resourceId }) => {
-  if (!storageMode.isAnyApi()) {
-    return knex(tableName)
-      .where({ id: resourceId })
-      .first()
-  }
-
-  return knex('any_records')
-    .where({
-      tenant_id: getTenantId(api),
-      resource,
-      logical_id: resourceId
-    })
-    .first()
-}
-
-const getStoredFieldValue = async ({ api, resource, row, field }) => {
-  if (!row) return undefined
-
-  if (!storageMode.isAnyApi()) {
-    return row[field]
-  }
-
-  if (field === 'id') {
-    return row.logical_id
-  }
-
-  const descriptor = await api.anyapi.registry.getDescriptor(getTenantId(api), resource)
-  const fieldInfo = descriptor?.fields?.[field]
-  if (fieldInfo?.slot) {
-    return row[fieldInfo.slot]
-  }
-
-  return row[field]
-}
-
-const loadStoredManyToManyLinks = async ({ api, ownerResource, relationshipName, ownerId }) => {
-  if (!storageMode.isAnyApi()) {
-    return knex('id_norm_override_publisher_tags')
-      .where({ publisher_id: ownerId })
-      .select('publisher_id', 'tag_id')
-  }
-
-  const tenantId = getTenantId(api)
-  const ownerDescriptor = await api.anyapi.registry.getDescriptor(tenantId, ownerResource)
-  const relationshipKey = ownerDescriptor?.manyToMany?.[relationshipName]?.relationship
-
-  const rows = await knex('any_links')
-    .where({ tenant_id: tenantId })
-    .andWhere((builder) => {
-      builder
-        .where((q) => {
-          q.where('relationship', relationshipKey)
-            .andWhere('left_resource', ownerResource)
-            .andWhere('left_id', ownerId)
-        })
-        .orWhere((q) => {
-          q.where('inverse_relationship', relationshipKey)
-            .andWhere('right_resource', ownerResource)
-            .andWhere('right_id', ownerId)
-        })
-    })
-    .select('left_resource', 'left_id', 'right_resource', 'right_id')
-
-  return rows.map((row) => {
-    if (row.left_resource === ownerResource) {
-      return {
-        publisher_id: row.left_id,
-        tag_id: row.right_id
-      }
-    }
-
-    return {
-      publisher_id: row.right_id,
-      tag_id: row.left_id
-    }
-  }).filter((row) => row.publisher_id === ownerId && row.tag_id != null)
-}
-
-describe('Resource ID normalization', () => {
-  before(async () => {
-    defaultApi = await createIdNormalizationApi(knex, {
-      tablePrefix: 'id_norm_default'
-    })
-
-    overrideApi = await createIdNormalizationApi(knex, {
-      tablePrefix: 'id_norm_override',
-      'rest-api': {
-        returnRecordApi: {
-          post: 'no',
-          put: false,
-          patch: false
-        },
-        normalizeId: (value) => {
-          if (value === null || value === undefined) {
-            return null
-          }
-
-          const normalized = String(value).trim()
-          return normalized ? normalized.toUpperCase() : null
-        }
-      },
-      countryResourceOptions: {
-        normalizeId: (value) => {
-          if (value === null || value === undefined) {
-            return null
-          }
-
-          const normalized = String(value).trim()
-          return normalized ? normalized.toLowerCase() : null
-        }
-      },
-      tagResourceOptions: {
-        normalizeId: (value) => {
-          if (value === null || value === undefined) {
-            return null
-          }
-
-          const normalized = String(value).trim()
-          return normalized ? normalized.toLowerCase() : null
-        }
-      }
-    })
-  })
-
-  after(async () => {
-    await knex.destroy()
-  })
-
-  beforeEach(async () => {
-    await cleanTables(knex, [
-      'id_norm_default_countries',
-      'id_norm_default_publishers',
-      'id_norm_default_tags',
-      'id_norm_default_publisher_tags',
-      'id_norm_override_countries',
-      'id_norm_override_publishers',
-      'id_norm_override_tags',
-      'id_norm_override_publisher_tags'
-    ])
-  })
-
-  it('uses the default normalizer to trim surrounding whitespace', async () => {
-    const countryId = 'country-default'
-    const countryDoc = createJsonApiDocument('countries', {
-      name: 'Canada'
-    })
-    countryDoc.data.id = countryId
-
-    await defaultApi.resources.countries.post({
-      inputRecord: countryDoc,
-      simplified: false
-    })
-
-    const result = await defaultApi.resources.countries.get({
-      id: `  ${countryId}  `,
-      simplified: false
-    })
-
-    validateJsonApiStructure(result)
-    assert.equal(result.data.id, countryId)
-    assert.equal(result.data.attributes.name, 'Canada')
-  })
-
-  it('lets a resource override the global normalizer', async () => {
-    const countryId = 'country-override'
-    const publisherId = 'publisher-override'
-    const countryDoc = createJsonApiDocument('countries', {
-      name: 'Spain'
-    })
-    countryDoc.data.id = countryId
-    const publisherDoc = createJsonApiDocument('publishers', {
-      name: 'Acme Press'
-    })
-    publisherDoc.data.id = publisherId
-
-    await overrideApi.resources.countries.post({
-      inputRecord: countryDoc,
-      simplified: false
-    })
-
-    await overrideApi.resources.publishers.post({
-      inputRecord: publisherDoc,
-      simplified: false
-    })
-
-    const countryResult = await overrideApi.resources.countries.get({
-      id: `  ${countryId.toUpperCase()}  `,
-      simplified: false
-    })
-
-    validateJsonApiStructure(countryResult)
-    assert.equal(countryResult.data.id, countryId)
-
-    const publisherResult = await overrideApi.resources.publishers.get({
-      id: `  ${publisherId}  `,
-      simplified: false
-    })
-
-    validateJsonApiStructure(publisherResult)
-    assert.equal(publisherResult.data.id, publisherId.toUpperCase())
-  })
-
-  it('normalizes explicit POST resource ids before persistence and return fetches', async () => {
-    const inputRecord = createJsonApiDocument('publishers', {
-      name: 'Explicit ID Press'
-    })
-    inputRecord.data.id = '  publisher-explicit  '
-
-    const result = await overrideApi.resources.publishers.post({
-      inputRecord,
-      simplified: false
-    })
-
-    assert.equal(result, undefined)
-
-    const inserted = await loadStoredResourceRow({
-      api: overrideApi,
-      resource: 'publishers',
-      tableName: 'id_norm_override_publishers',
-      resourceId: 'PUBLISHER-EXPLICIT'
-    })
-
-    assert.equal(await getStoredFieldValue({
-      api: overrideApi,
-      resource: 'publishers',
-      row: inserted,
-      field: 'id'
-    }), 'PUBLISHER-EXPLICIT')
-
-    const fetched = await overrideApi.resources.publishers.get({
-      id: 'publisher-explicit',
-      simplified: false
-    })
-
-    validateJsonApiStructure(fetched)
-    assert.equal(fetched.data.id, 'PUBLISHER-EXPLICIT')
-  })
-
-  it('rejects explicit POST resource ids that normalize to empty values', async () => {
-    const inputRecord = createJsonApiDocument('publishers', {
-      name: 'Invalid ID Press'
-    })
-    inputRecord.data.id = '   '
-
-    await assert.rejects(
-      () => overrideApi.resources.publishers.post({
-        inputRecord,
-        simplified: false
-      }),
-      (error) => {
-        assert.equal(error.code, 'REST_API_VALIDATION')
-        assert.deepEqual(error.details?.fields, ['data.id'])
-        assert.equal(error.details?.violations?.[0]?.field, 'data.id')
-        assert.equal(error.details?.violations?.[0]?.rule, 'invalid_resource_id')
-        return true
-      }
-    )
-  })
-
-  it('treats record ids that normalize to empty values as not found', async () => {
-    await assert.rejects(
-      () => overrideApi.resources.publishers.get({
-        id: '   ',
-        simplified: false
-      }),
-      (error) => {
-        assert.equal(error.code, 'REST_API_RESOURCE')
-        assert.equal(error.subtype, 'not_found')
-        assert.equal(error.details?.resourceType, 'publishers')
-        assert.equal(error.details?.resourceId, '   ')
-        return true
-      }
-    )
-  })
-
-  it('normalizes belongsTo relationship ids using the related resource normalizer before persistence', async () => {
-    const countryRecord = createJsonApiDocument('countries', {
-      name: 'Spain'
-    })
-    countryRecord.data.id = 'country-1'
-
-    await overrideApi.resources.countries.post({
-      inputRecord: countryRecord,
-      simplified: false
-    })
-
-    const publisherRecord = createJsonApiDocument('publishers', {
-      name: 'Country Linked Press'
-    }, {
-      country: {
-        data: {
-          type: 'countries',
-          id: '  COUNTRY-1  '
-        }
-      }
-    })
-    publisherRecord.data.id = 'publisher-country'
-
-    await overrideApi.resources.publishers.post({
-      inputRecord: publisherRecord,
-      simplified: false
-    })
-
-    const inserted = await loadStoredResourceRow({
-      api: overrideApi,
-      resource: 'publishers',
-      tableName: 'id_norm_override_publishers',
-      resourceId: 'PUBLISHER-COUNTRY'
-    })
-
-    assert.equal(await getStoredFieldValue({
-      api: overrideApi,
-      resource: 'publishers',
-      row: inserted,
-      field: 'country_id'
-    }), 'country-1')
-  })
-
-  it('rejects relationship identifiers that normalize to empty values', async () => {
-    const publisherRecord = createJsonApiDocument('publishers', {
-      name: 'Invalid Relationship Press'
-    })
-    publisherRecord.data.id = 'publisher-invalid-relationship'
-
-    await overrideApi.resources.publishers.post({
-      inputRecord: publisherRecord,
-      simplified: false
-    })
-
-    await assert.rejects(
-      () => overrideApi.resources.publishers.postRelationship({
-        id: 'publisher-invalid-relationship',
-        relationshipName: 'tags',
-        relationshipData: [
-          {
-            type: 'tags',
-            id: '   '
-          }
-        ],
-        simplified: false
-      }),
-      (error) => {
-        assert.equal(error.code, 'REST_API_RESOURCE')
-        assert.equal(error.subtype, 'not_found')
-        assert.equal(error.details?.resourceType, 'tags')
-        assert.equal(error.details?.resourceId, '   ')
-        return true
-      }
-    )
-  })
-
-  it('normalizes many-to-many relationship ids before pivot inserts and deletes', async () => {
-    const tagRecord = createJsonApiDocument('tags', {
-      name: 'Featured'
-    })
-    tagRecord.data.id = 'tag-1'
-
-    await overrideApi.resources.tags.post({
-      inputRecord: tagRecord,
-      simplified: false
-    })
-
-    const publisherRecord = createJsonApiDocument('publishers', {
-      name: 'Tagged Press'
-    })
-    publisherRecord.data.id = 'publisher-tags'
-
-    await overrideApi.resources.publishers.post({
-      inputRecord: publisherRecord,
-      simplified: false
-    })
-
-    await overrideApi.resources.publishers.postRelationship({
-      id: ' publisher-tags ',
-      relationshipName: 'tags',
-      relationshipData: [
-        {
-          type: 'tags',
-          id: '  TAG-1  '
-        }
-      ],
-      simplified: false
-    })
-
-    let pivotRows = await loadStoredManyToManyLinks({
-      api: overrideApi,
-      ownerResource: 'publishers',
-      relationshipName: 'tags',
-      ownerId: 'PUBLISHER-TAGS'
-    })
-
-    assert.deepEqual(pivotRows, [{
-      publisher_id: 'PUBLISHER-TAGS',
-      tag_id: 'tag-1'
-    }])
-
-    await overrideApi.resources.publishers.deleteRelationship({
-      id: 'publisher-tags',
-      relationshipName: 'tags',
-      relationshipData: [
-        {
-          type: 'tags',
-          id: ' TAG-1 '
-        }
-      ],
-      simplified: false
-    })
-
-    pivotRows = await loadStoredManyToManyLinks({
-      api: overrideApi,
-      ownerResource: 'publishers',
-      relationshipName: 'tags',
-      ownerId: 'PUBLISHER-TAGS'
-    })
-
-    assert.deepEqual(pivotRows, [])
-  })
-})