refactor(atlas-data): document as experimental and not fully implemen…

…ted #36

README.md

@@ -98,8 +98,9 @@ Run the unit tests, lint, and check formatting run:
 deno task test
 ```
 
-> To run the integration tests, you will need an instance of MongoDB running. If you're developing
-> in [`Gitpod`](https://gitpod.io), a MongoDB instance is automatically started for you
+> To run the integration tests, you will need an instance of MongoDB running, along with setting
+> `MONGO_URL` to your connection string. If you're developing in [`Gitpod`](https://gitpod.io), a
+> MongoDB instance is automatically started for you
 
 To run the tests on the adapter methods run:
 

clients/atlas.test.ts → clients/atlas-data.test.ts

@@ -1,8 +1,8 @@
 import { assertEquals, assertObjectMatch, assertThrows, deferred } from '../dev_deps.ts'
 
-import { AtlasClient } from './atlas.ts'
+import { AtlasDataClient } from './atlas-data.ts'
 
-Deno.test('client - atlas', async (t) => {
+Deno.test('client - atlas-data', async (t) => {
   let fetchMock = deferred<{ url: string; init: RequestInit }>()
 
   const happy = {
@@ -21,7 +21,7 @@ Deno.test('client - atlas', async (t) => {
   }
 
   await t.step('should append the method to the url', async () => {
-    const client = new AtlasClient(happy)
+    const client = new AtlasDataClient(happy)
     fetchMock = deferred<{ url: string; init: RequestInit }>()
 
     await client
@@ -39,7 +39,7 @@ Deno.test('client - atlas', async (t) => {
 
   await t.step('should append the headers to the request', async (t) => {
     await t.step('Content-Type and Accept', async () => {
-      const client = new AtlasClient(happy)
+      const client = new AtlasDataClient(happy)
       fetchMock = deferred<{ url: string; init: RequestInit }>()
 
       await client
@@ -56,7 +56,7 @@ Deno.test('client - atlas', async (t) => {
 
     await t.step('auth', async (t) => {
       await t.step('api-key', async () => {
-        const client = new AtlasClient(happy)
+        const client = new AtlasDataClient(happy)
         fetchMock = deferred<{ url: string; init: RequestInit }>()
 
         await client
@@ -71,7 +71,7 @@ Deno.test('client - atlas', async (t) => {
       })
 
       await t.step('jwtTokenString', async () => {
-        const client = new AtlasClient({
+        const client = new AtlasDataClient({
           ...happy,
           auth: { jwtTokenString: 'foobar' },
         })
@@ -89,7 +89,7 @@ Deno.test('client - atlas', async (t) => {
       })
 
       await t.step('email and password', async () => {
-        const client = new AtlasClient({
+        const client = new AtlasDataClient({
           ...happy,
           auth: { email: '[email protected]', password: 'secret' },
         })
@@ -111,7 +111,7 @@ Deno.test('client - atlas', async (t) => {
 
   await t.step('should append the body to the request', async (t) => {
     await t.step('database, collection, and dataSource', async () => {
-      const client = new AtlasClient(happy)
+      const client = new AtlasDataClient(happy)
       fetchMock = deferred<{ url: string; init: RequestInit }>()
 
       await client
@@ -129,7 +129,7 @@ Deno.test('client - atlas', async (t) => {
     })
 
     await t.step('options', async () => {
-      const client = new AtlasClient(happy)
+      const client = new AtlasDataClient(happy)
       fetchMock = deferred<{ url: string; init: RequestInit }>()
 
       await client
@@ -149,6 +149,6 @@ Deno.test('client - atlas', async (t) => {
   await t.step('should throw if credentials are not provided', () => {
     // deno-lint-ignore ban-ts-comment
     // @ts-expect-error
-    assertThrows(() => new AtlasClient({ ...happy, auth: {} }))
+    assertThrows(() => new AtlasDataClient({ ...happy, auth: {} }))
   })
 })

clients/atlas.ts → clients/atlas-data.ts

@@ -1,5 +1,9 @@
-import { HyperErr } from 'https://raw.githubusercontent.com/hyper63/hyper/hyper-utils%40v0.1.1/packages/utils/hyper-err.js'
-import { EJSON } from '../deps.ts'
+/**
+ * Not fully implemented or tested
+ *
+ * See https://github.com/hyper63/hyper-adapter-mongodb/issues/36
+ */
+import { EJSON, HyperErr } from '../deps.ts'
 import type { AuthOptions, Document } from '../types.ts'
 
 import type {
@@ -9,7 +13,7 @@ import type {
   MongoInstanceClient,
 } from './types.ts'
 
-export class AtlasClient implements MongoInstanceClient {
+export class AtlasDataClient implements MongoInstanceClient {
   dataSource: string
   endpoint: string
   fetch = fetch
@@ -52,9 +56,9 @@ export class AtlasClient implements MongoInstanceClient {
 
 export class Database implements MongoDatabaseClient {
   name: string
-  client: AtlasClient
+  client: AtlasDataClient
 
-  constructor(name: string, client: AtlasClient) {
+  constructor(name: string, client: AtlasDataClient) {
     this.name = name
     this.client = client
   }
@@ -82,7 +86,7 @@ export class Database implements MongoDatabaseClient {
 export class Collection<T extends Document> implements MongoCollectionClient<T> {
   name: string
   database: Database
-  client: AtlasClient
+  client: AtlasDataClient
 
   constructor(name: string, database: Database) {
     this.name = name

mod.test.ts

@@ -1,6 +1,6 @@
 import { assert, assertRejects, dataPort, pluginFactory } from './dev_deps.ts'
 
-import { AtlasClient } from './clients/atlas.ts'
+import { AtlasDataClient } from './clients/atlas-data.ts'
 import factory from './mod.ts'
 import { MetaDb } from './meta.ts'
 
@@ -21,11 +21,14 @@ Deno.test('mod', async (t) => {
   })
 
   await t.step('load', async (t) => {
-    await t.step('should construct an Atlas Data client and MetaDb client', async () => {
-      const { client, meta } = await factory(happy).load()
-      assert(client instanceof AtlasClient)
-      assert(meta instanceof MetaDb)
-    })
+    await t.step(
+      'should construct an AtlasData client and MetaDb client',
+      async () => {
+        const { client, meta } = await factory(happy).load()
+        assert(client instanceof AtlasDataClient)
+        assert(meta instanceof MetaDb)
+      },
+    )
 
     await t.step('should throw if the provided url is not valid', async () => {
       await assertRejects(() =>

mod.ts

@@ -1,7 +1,7 @@
 import type { AdapterConfig } from './types.ts'
 import PORT_NAME from './port_name.ts'
 
-import { AtlasClient } from './clients/atlas.ts'
+import { AtlasDataClient } from './clients/atlas-data.ts'
 import { NativeClient } from './clients/native.ts'
 import type { MongoInstanceClient } from './clients/types.ts'
 
@@ -16,7 +16,7 @@ export default (config: AdapterConfig) => ({
   port: PORT_NAME,
   load: async () => {
     const url = new URL(config.url)
-    let client: NativeClient | AtlasClient
+    let client: NativeClient | AtlasDataClient
 
     if (isNative(url)) {
       client = new NativeClient({ url: config.url })
@@ -27,7 +27,7 @@ export default (config: AdapterConfig) => ({
           'options.atlas is required when using an Atlas Data url',
         )
       }
-      client = new AtlasClient({
+      client = new AtlasDataClient({
         ...config.options.atlas,
         endpoint: config.url,
         fetch,