Merge pull request #33 from desci-labs/m0ar/disable-indexes

Temporarily disable query indexes as bug workaround
desci-labs · Jan 15, 2024 · 67d5f60 · 67d5f60
2 parents c652afc + a1ce9ef
commit 67d5f60
Show file tree

Hide file tree

Showing 21 changed files with 745 additions and 439 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -0,0 +1,20 @@
+name: Publish codex-lib to npmjs
+on:
+  release:
+    types: [published]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: "npm"
+          cache-dependency-path: "package-lock.json"
+          check-latest: false
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -25,5 +25,8 @@
     "prettier": "^3.1.0",
     "typedoc": "^0.25.4",
     "typescript": "^5.2.2"
+  },
+  "dependencies": {
+    "@desci-labs/desci-models": "^0.1.22"
   }
 }
diff --git a/packages/composedb/.gitignore b/packages/composedb/.gitignore
@@ -1,3 +1,2 @@
 src/__generated__/*
 !src/__generates__/*.d.ts
-
diff --git a/packages/composedb/composites/1-claim.graphql b/packages/composedb/composites/1-claim.graphql
@@ -3,8 +3,9 @@ type Claim
     accountRelation: LIST
     description: "A reusable claim to be granted via attestation"
   )
-  @createIndex(fields: [{ path: "title" }])
-  @createIndex(fields: [{ path: "badge" }]) {
+  # @createIndex(fields: [{ path: "title" }])
+  # @createIndex(fields: [{ path: "badge" }]) 
+{
   owner: DID! @documentAccount
   version: CommitID! @documentVersion
   title: String! @string(maxLength: 100)

diff --git a/packages/composedb/composites/1-researchObject.graphql b/packages/composedb/composites/1-researchObject.graphql
@@ -1,6 +1,7 @@
 type ResearchObject
   @createModel(accountRelation: LIST, description: "A research object")
-  @createIndex(fields: [{ path: "title" }]) {
+  # @createIndex(fields: [{ path: "title" }])
+{
   owner: DID! @documentAccount
   version: CommitID! @documentVersion
   title: String! @string(maxLength: 250)

diff --git a/packages/composedb/composites/1-socialHandle.graphql b/packages/composedb/composites/1-socialHandle.graphql
@@ -1,7 +1,7 @@
 type SocialHandle
   @createModel(accountRelation: LIST, description: "A social handle on other platforms")
-  @createIndex(fields: [{ path: "platform"}])
-  @createIndex(fields: [{ path: "handle"}])
+  # @createIndex(fields: [{ path: "platform"}])
+  # @createIndex(fields: [{ path: "handle"}])
 {
   owner: DID! @documentAccount
   version: CommitID! @documentVersion

diff --git a/packages/composedb/composites/2-annotation.graphql b/packages/composedb/composites/2-annotation.graphql
@@ -8,10 +8,11 @@ type ResearchObject @loadModel(id: "$RESEARCH_OBJECT_ID") {
 
 type Annotation
   @createModel(accountRelation: LIST, description: "Textual commentary")
-  @createIndex(fields: [{ path: "targetID" }])
-  @createIndex(fields: [{ path: "claimID" }])
-  @createIndex(fields: [{ path: "researchObjectID" }])
-  @createIndex(fields: [{ path: "dagNode" }]) {
+  # @createIndex(fields: [{ path: "targetID" }])
+  # @createIndex(fields: [{ path: "claimID" }])
+  # @createIndex(fields: [{ path: "researchObjectID" }])
+  # @createIndex(fields: [{ path: "dagNode" }])
+{
   owner: DID! @documentAccount
   version: CommitID! @documentVersion
 

diff --git a/packages/composedb/composites/2-attestation.graphql b/packages/composedb/composites/2-attestation.graphql
@@ -4,9 +4,10 @@ type Claim @loadModel(id: "$CLAIM_ID") {
 
 type Attestation
   @createModel(accountRelation: LIST, description: "General attestation")
-  @createIndex(fields: [{ path: "revoked" }])
-  @createIndex(fields: [{ path: "targetVersion" }])
-  @createIndex(fields: [{ path: "claimVersion" }]) {
+  # @createIndex(fields: [{ path: "revoked" }])
+  # @createIndex(fields: [{ path: "targetVersion" }])
+  # @createIndex(fields: [{ path: "claimVersion" }])
+{
   owner: DID! @documentAccount
   version: CommitID! @documentVersion
   # 1. Any type of document, shown with relation on reciever end but cannot use

diff --git a/packages/composedb/composites/2-contributorRelation.graphql b/packages/composedb/composites/2-contributorRelation.graphql
@@ -11,9 +11,10 @@ type ContributorRelation
     accountRelation: LIST
     description: "List a contributor on a research object"
   )
-  @createIndex(fields: [{ path: "role" }])
-  @createIndex(fields: [{ path: "revoked" }])
-  @createIndex(fields: [{ path: "researchObjectVersion" }]) {
+  # @createIndex(fields: [{ path: "role" }])
+  # @createIndex(fields: [{ path: "revoked" }])
+  # @createIndex(fields: [{ path: "researchObjectVersion" }])
+{
   owner: DID! @documentAccount
   version: CommitID! @documentVersion
 

diff --git a/packages/composedb/composites/2-referenceRelation.graphql b/packages/composedb/composites/2-referenceRelation.graphql
@@ -7,9 +7,10 @@ type ReferenceRelation
     accountRelation: LIST
     description: "Indicate a reference between research objects"
   )
-  @createIndex(fields: [{ path: "fromVersion" }])
-  @createIndex(fields: [{ path: "toVersion" }])
-  @createIndex(fields: [{ path: "revoked" }]) {
+  # @createIndex(fields: [{ path: "fromVersion" }])
+  # @createIndex(fields: [{ path: "toVersion" }])
+  # @createIndex(fields: [{ path: "revoked" }])
+{
   owner: DID! @documentAccount
   version: CommitID! @documentVersion
 

diff --git a/packages/composedb/composites/2-researchComponent.graphql b/packages/composedb/composites/2-researchComponent.graphql
@@ -7,10 +7,11 @@ type ResearchComponent
     accountRelation: LIST
     description: "A contextualized DAG pointer for a research object"
   )
-  @createIndex(fields: [{ path: "mimeType" }])
-  @createIndex(fields: [{ path: "researchObjectVersion" }])
+  # @createIndex(fields: [{ path: "mimeType" }])
+  # @createIndex(fields: [{ path: "researchObjectVersion" }])
   # Don't join index with path as it prevents efficient reverse CID lookups
-  @createIndex(fields: [{ path: "dagNode" }]) {
+  # @createIndex(fields: [{ path: "dagNode" }]) 
+{
   owner: DID! @documentAccount
   version: CommitID! @documentVersion
   name: String! @string(maxLength: 512)

diff --git a/packages/composedb/package.json b/packages/composedb/package.json
@@ -13,10 +13,10 @@
     "kill": "pkill --full \"ceramic daemon|ipfs daemon\""
   },
   "devDependencies": {
-    "@ceramicnetwork/cli": "^3.0.0",
-    "@ceramicnetwork/http-client": "^3.0.0",
-    "@composedb/devtools": "^0.6.0",
-    "@composedb/devtools-node": "^0.6.0",
+    "@ceramicnetwork/cli": "^3.1.0",
+    "@ceramicnetwork/http-client": "^3.1.0",
+    "@composedb/devtools": "^0.6.1",
+    "@composedb/devtools-node": "^0.6.1",
     "dids": "^4.0.4",
     "key-did-provider-ed25519": "^3.0.2",
     "key-did-resolver": "^3.0.0",

diff --git a/packages/lib/.npmignore b/packages/lib/.npmignore
@@ -0,0 +1,9 @@
+node_modules
+admin_seed.txt
+local-data
+composedb.config.json
+test.config.json
+*.tsbuildinfo
+.vscode
+dist/test/
+dist/scripts/
diff --git a/packages/lib/LICENCE b/packages/lib/LICENCE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 DeSci Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/packages/lib/README.md b/packages/lib/README.md
@@ -4,12 +4,24 @@
 This package implements a typed API for interacting directly with Codex, by
 talking directly with a Ceramic and/or ComposeDB node.
 
-## Usage
+## Installation
 Install as dependency:
 
-> Note: this package is currently not automatically published, but this works
-  regardless within the repo.
+> Note: this package is currently not automatically published, but this will
+  work regardless for the other packages inside the repo (`-composedb` and `-cli`).
 
 ```bash
 npm install @desci-labs/desci-codex-lib
 ```
+
+## Usage
+Most functions require passing in a Ceramic or composeDB client, which can be
+instantiated using the tools in `clients.ts`. Without explicit configuration,
+the clients will default to a Ceramic node at `localhost:7007`.
+
+Do note that when running against a local node, you likely want to compile
+and deploy the composites in `desci-codex-composedb`.
+
+### Tests
+The test suite depends on the models in `desci-codex-composedb`, and are
+easiest to invoke my running `make test` in the repo root instead of here.
diff --git a/packages/lib/package.json b/packages/lib/package.json
@@ -5,6 +5,8 @@
   "license": "MIT",
   "author": "Edvard Hübinette",
   "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
     "build": "rm -rf ./dist && tsc --project tsconfig.build.json",
     "populate": "node --no-warnings=ExperimentalWarning --loader ts-node/esm scripts/populate.ts",

diff --git a/packages/lib/src/clients.ts b/packages/lib/src/clients.ts
@@ -63,3 +63,5 @@ export const didFromSeed = async (seed: string) => {
   await did.authenticate();
   return did;
 };
+
+export type { ComposeClient, CeramicClient };
diff --git a/packages/lib/src/types.ts b/packages/lib/src/types.ts
@@ -332,7 +332,7 @@ export type PartialWithID<T> = Partial<T> & {
 /**
  * Get all keys of a union type, conditional to get union distribution.
  */
-type UnionKeys<T> = T extends unknown ? keyof T : never;
+export type UnionKeys<T> = T extends unknown ? keyof T : never;
 
 /**
  * Omit from all subtypes in a union, like mapping `Omit` over all members.

diff --git a/packages/lib/test/root.spec.ts b/packages/lib/test/root.spec.ts
@@ -662,6 +662,7 @@ describe("ComposeDB nodes", () => {
         composeClient,
         contributionData,
       );
+      await waitAndSync(contribution.streamID);
       await updateContributorRelation(composeClient, {
         id: contribution.streamID,
         revoked: true,
@@ -763,6 +764,7 @@ describe("ComposeDB nodes", () => {
         composeClient,
         referenceData,
       );
+      await waitAndSync(reference.streamID);
       await updateReferenceRelation(composeClient, {
         id: reference.streamID,
         revoked: true,

diff --git a/packages/lib/tsconfig.build.json b/packages/lib/tsconfig.build.json
@@ -4,12 +4,5 @@
     "test/**/*",
     "vitest*",
     "dist"
-  ],
-  "compilerOptions": {
-    "noEmit": false,
-    "outDir": "dist",
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true
-  }
+  ]
 }