@api-client/core 0.14.9 → 0.15.0

package/tests/unit/models/http_history.spec.ts

@@ -0,0 +1,443 @@
+import { test } from '@japa/runner'
+import { assert } from '@esm-bundle/chai'
+import {
+  HttpHistory,
+  IHttpHistory,
+  createdSymbol,
+  midnightSymbol,
+  Kind as HttpHistoryKind,
+} from '../../../src/models/HttpHistory.js'
+import { SentRequest, ISentRequest } from '../../../src/models/SentRequest.js'
+import { RequestLog, Kind as RequestLogKind } from '../../../src/models/RequestLog.js'
+import { Kind as HttpRequestKind } from '../../../src/models/HttpRequest.js'
+
+test.group('HttpHistory #created', () => {
+  test('sets the value', () => {
+    const instance = new HttpHistory()
+    instance.created = 1234
+    assert.equal(instance.created, 1234)
+  })
+
+  test('sets the current time when value is missing', () => {
+    const instance = new HttpHistory()
+    const now = Date.now()
+    instance.created = undefined
+    assert.approximately(instance.created, now, 100)
+  })
+})
+
+test.group('HttpHistory #midnight', () => {
+  test('sets the value', () => {
+    const instance = new HttpHistory()
+    instance.midnight = 1234
+    assert.equal(instance.midnight, 1234)
+  })
+
+  test('sets the default value when the value is missing', () => {
+    const instance = new HttpHistory()
+    instance[createdSymbol] = 1641774295483
+    instance.midnight = undefined
+    // assert.equal(instance.midnight, 1641715200000);
+    assert.typeOf(instance.midnight, 'number')
+  })
+
+  test('reads the default value when not set', () => {
+    const instance = new HttpHistory()
+    instance[createdSymbol] = 1641774295483
+    // @ts-expect-error Used in testing
+    instance[midnightSymbol] = undefined
+    // assert.equal(instance.midnight, 1641715200000);
+    assert.typeOf(instance.midnight, 'number')
+  })
+})
+
+test.group('HttpHistory constructor()', () => {
+  test('creates the default values', () => {
+    const now = Date.now()
+    const instance = new HttpHistory()
+    assert.equal(instance.kind, HttpHistoryKind)
+    assert.typeOf(instance.created, 'number')
+    assert.approximately(instance.created, now, 100)
+    const { log } = instance
+    assert.typeOf(log, 'object', 'sets the log')
+    assert.equal(instance.user, '')
+    assert.equal(instance.organization, '')
+    assert.equal(instance.project, '')
+    assert.equal(instance.request, '')
+  })
+
+  test('creates values from the schema', () => {
+    const now = Date.now()
+    const schema: IHttpHistory = {
+      kind: HttpHistoryKind,
+      created: now,
+      user: 'u1',
+      organization: 's1',
+      project: 'p1',
+      request: 'r1',
+      app: 'a1',
+      key: '',
+      log: {
+        kind: RequestLogKind,
+        request: {
+          kind: HttpRequestKind,
+          url: 'https://dot.com',
+          headers: 'x-test: true',
+          method: 'PUT',
+          startTime: 0,
+        },
+      },
+    }
+    const instance = new HttpHistory(schema)
+
+    assert.equal(instance.kind, HttpHistoryKind)
+    assert.equal(instance.created, now)
+    assert.equal(instance.user, 'u1')
+    assert.equal(instance.organization, 's1')
+    assert.equal(instance.project, 'p1')
+    assert.equal(instance.project, 'p1')
+    assert.equal(instance.request, 'r1')
+    assert.equal(instance.app, 'a1')
+
+    const { log } = instance
+    assert.typeOf(log, 'object', 'sets the log')
+    assert.typeOf(log.request, 'object', 'sets the log.request')
+    const request = log.request as SentRequest
+    assert.equal(request.method, 'PUT')
+    assert.equal(request.url, 'https://dot.com')
+  })
+
+  test('creates values from the JSON schema string', () => {
+    const now = Date.now()
+    const schema: IHttpHistory = {
+      kind: HttpHistoryKind,
+      created: now,
+      user: 'u1',
+      organization: 's1',
+      project: 'p1',
+      request: 'r1',
+      app: 'a1',
+      key: '',
+      log: {
+        kind: RequestLogKind,
+        request: {
+          kind: HttpRequestKind,
+          url: 'https://dot.com',
+          headers: 'x-test: true',
+          method: 'PUT',
+          startTime: 0,
+        },
+      },
+    }
+    const instance = new HttpHistory(JSON.stringify(schema))
+
+    assert.equal(instance.kind, HttpHistoryKind)
+    assert.equal(instance.created, now)
+    assert.equal(instance.user, 'u1')
+    assert.equal(instance.organization, 's1')
+    assert.equal(instance.project, 'p1')
+    assert.equal(instance.project, 'p1')
+    assert.equal(instance.request, 'r1')
+
+    const { log } = instance
+    assert.typeOf(log, 'object', 'sets the log')
+    assert.typeOf(log.request, 'object', 'sets the log.request')
+    const request = log.request as SentRequest
+    assert.equal(request.method, 'PUT')
+    assert.equal(request.url, 'https://dot.com')
+  })
+})
+
+test.group('HttpHistory new()', () => {
+  test('sets the passed log', () => {
+    const instance = new HttpHistory()
+    const schema = instance.toJSON()
+    schema.log.request = {
+      kind: HttpRequestKind,
+      url: 'https://dot.com',
+      headers: 'x-test: true',
+      method: 'PUT',
+      startTime: 0,
+    }
+    instance.new(schema)
+
+    const { log } = instance
+    assert.typeOf(log, 'object', 'sets the log')
+    assert.typeOf(log.request, 'object', 'sets the log.request')
+    const request = log.request as SentRequest
+    assert.equal(request.method, 'PUT')
+    assert.equal(request.url, 'https://dot.com')
+  })
+
+  test('sets the default log', () => {
+    const instance = new HttpHistory()
+    const schema = instance.toJSON()
+    instance.new(schema)
+
+    const { log } = instance
+    assert.typeOf(log, 'object', 'sets the log')
+    assert.isUndefined(log.request, 'has no log.request')
+  })
+
+  test('sets the passed key', () => {
+    const instance = new HttpHistory()
+    const schema = instance.toJSON()
+    schema.key = 'a'
+    instance.new(schema)
+
+    assert.equal(instance.key, 'a')
+  })
+
+  test('sets the default key', () => {
+    const instance = new HttpHistory()
+    instance.key = 'test'
+    const schema = instance.toJSON()
+    // @ts-expect-error Used in testing
+    delete schema.key
+    instance.new(schema)
+
+    assert.equal(instance.key, '')
+  })
+
+  test('sets the passed organization', () => {
+    const instance = new HttpHistory()
+    const schema = instance.toJSON()
+    schema.organization = 'a'
+    instance.new(schema)
+
+    assert.equal(instance.organization, 'a')
+  })
+
+  test('sets the default organization', () => {
+    const instance = new HttpHistory()
+    instance.organization = 'test'
+    const schema = instance.toJSON()
+    // @ts-expect-error Used in testing
+    delete schema.organization
+    instance.new(schema)
+
+    assert.equal(instance.organization, '')
+  })
+
+  test('sets the passed app', () => {
+    const instance = new HttpHistory()
+    const schema = instance.toJSON()
+    schema.app = 'a'
+    instance.new(schema)
+
+    assert.equal(instance.app, 'a')
+  })
+
+  test('sets the default app', () => {
+    const instance = new HttpHistory()
+    instance.app = 'test'
+    const schema = instance.toJSON()
+    // @ts-expect-error Used in testing
+    delete schema.app
+    instance.new(schema)
+
+    assert.equal(instance.app, '')
+  })
+
+  test('sets the passed user', () => {
+    const instance = new HttpHistory()
+    const schema = instance.toJSON()
+    schema.user = 'a'
+    instance.new(schema)
+
+    assert.equal(instance.user, 'a')
+  })
+
+  test('sets the default user', () => {
+    const instance = new HttpHistory()
+    instance.user = 'test'
+    const schema = instance.toJSON()
+    delete schema.user
+    instance.new(schema)
+
+    assert.equal(instance.user, '')
+  })
+
+  test('sets the passed project', () => {
+    const instance = new HttpHistory()
+    const schema = instance.toJSON()
+    schema.project = 'a'
+    instance.new(schema)
+
+    assert.equal(instance.project, 'a')
+  })
+
+  test('sets the default project', () => {
+    const instance = new HttpHistory()
+    instance.project = 'test'
+    const schema = instance.toJSON()
+    // @ts-expect-error Used in testing
+    delete schema.project
+    instance.new(schema)
+
+    assert.equal(instance.project, '')
+  })
+
+  test('sets the passed request', () => {
+    const instance = new HttpHistory()
+    const schema = instance.toJSON()
+    schema.request = 'a'
+    instance.new(schema)
+
+    assert.equal(instance.request, 'a')
+  })
+
+  test('sets the default request', () => {
+    const instance = new HttpHistory()
+    instance.request = 'test'
+    const schema = instance.toJSON()
+    // @ts-expect-error Used in testing
+    delete schema.request
+    instance.new(schema)
+
+    assert.equal(instance.request, '')
+  })
+
+  test('sets the created', () => {
+    const instance = new HttpHistory()
+    const schema = instance.toJSON()
+    schema.created = 1234567
+    instance.new(schema)
+    assert.equal(instance.created, 1234567)
+  })
+
+  test('sets the created as current time', () => {
+    const now = Date.now()
+    const instance = new HttpHistory()
+    const schema = instance.toJSON()
+    // @ts-expect-error Used in testing
+    delete schema.created
+    instance.new(schema)
+    assert.approximately(instance.created, now, 100)
+  })
+
+  test('sets the midnight', () => {
+    const instance = new HttpHistory()
+    const schema = instance.toJSON()
+    schema.midnight = 1234567
+    instance.new(schema)
+    assert.equal(instance.midnight, 1234567)
+  })
+})
+
+test.group('HttpHistory toJSON()', () => {
+  test('sets the log', () => {
+    const instance = new HttpHistory()
+    instance.log = RequestLog.fromRequest({
+      kind: HttpRequestKind,
+      url: 'https://dot.com',
+      headers: 'x-test: true',
+      method: 'PUT',
+      startTime: 0,
+    })
+
+    const result = instance.toJSON()
+    const data = result.log.request as ISentRequest
+
+    assert.equal(data.url, 'https://dot.com')
+    assert.equal(data.method, 'PUT')
+    assert.equal(data.headers, 'x-test: true')
+  })
+
+  test('sets the kind', () => {
+    const instance = new HttpHistory()
+    const result = instance.toJSON()
+
+    assert.equal(result.kind, HttpHistoryKind)
+  })
+
+  test('sets the created and midnight', () => {
+    const now = Date.now()
+    const instance = new HttpHistory()
+    instance.created = now
+    instance.midnight = 1234
+
+    const result = instance.toJSON()
+
+    assert.equal(result.created, now)
+    assert.equal(result.midnight, 1234)
+  })
+
+  test('sets the key', () => {
+    const instance = new HttpHistory()
+    instance.key = 'test'
+    const result = instance.toJSON()
+    assert.equal(result.key, 'test')
+  })
+
+  test('does not set the key when missing', () => {
+    const instance = new HttpHistory()
+    const result = instance.toJSON()
+    assert.equal(result.key, '')
+  })
+
+  test('sets the organization', () => {
+    const instance = new HttpHistory()
+    instance.organization = 'test'
+    const result = instance.toJSON()
+    assert.equal(result.organization, 'test')
+  })
+
+  test('does not set the organization when missing', () => {
+    const instance = new HttpHistory()
+    const result = instance.toJSON()
+    assert.equal(result.organization, '')
+  })
+
+  test('sets the app', () => {
+    const instance = new HttpHistory()
+    instance.app = 'test'
+    const result = instance.toJSON()
+    assert.equal(result.app, 'test')
+  })
+
+  test('does not set the app when missing', () => {
+    const instance = new HttpHistory()
+    const result = instance.toJSON()
+    assert.equal(result.app, '')
+  })
+
+  test('sets the project', () => {
+    const instance = new HttpHistory()
+    instance.project = 'test'
+    const result = instance.toJSON()
+    assert.equal(result.project, 'test')
+  })
+
+  test('does not set the project when missing', () => {
+    const instance = new HttpHistory()
+    const result = instance.toJSON()
+    assert.equal(result.project, '')
+  })
+
+  test('sets the user', () => {
+    const instance = new HttpHistory()
+    instance.user = 'test'
+    const result = instance.toJSON()
+    assert.equal(result.user, 'test')
+  })
+
+  test('sets the default user when missing', () => {
+    const instance = new HttpHistory()
+    const result = instance.toJSON()
+    assert.equal(result.user, '')
+  })
+
+  test('sets the request', () => {
+    const instance = new HttpHistory()
+    instance.request = 'test'
+    const result = instance.toJSON()
+    assert.equal(result.request, 'test')
+  })
+
+  test('does not set the request when missing', () => {
+    const instance = new HttpHistory()
+    const result = instance.toJSON()
+    assert.equal(result.request, '')
+  })
+})