Merge branch 'master' of github.com:waku-org/js-waku into feat/metadata-protocol

Author: danisharora099

.cspell.json

@@ -7,6 +7,8 @@
     "ahadns",
     "Alives",
     "asym",
+    "autoshard",
+    "autosharding",
     "backoff",
     "backoffs",
     "bitauth",
@@ -123,7 +125,7 @@
     "Привет",
     "مرحبا"
   ],
-  "flagWords": ["pubSub", "pubSubTopics", "pubSubTopic"],
+  "flagWords": ["pubSub: pubsub", "pubSubTopics: pubsubTopics", "pubSubTopic: pubsubTopic", "PubSub: Pubsub", "PubSubTopics: PubsubTopics", "PubSubTopic: PubsubTopic", "DefaultPubSubTopic: DefaultPubsubTopic"],
   "ignorePaths": [
     "package.json",
     "package-lock.json",

.eslintrc.json

@@ -72,7 +72,8 @@
     "@typescript-eslint/no-floating-promises": "error",
     "@typescript-eslint/await-thenable": "error",
     "@typescript-eslint/no-misused-promises": "error",
-    "@typescript-eslint/no-explicit-any": "warn"
+    "@typescript-eslint/no-explicit-any": "warn",
+    "id-match": ["error", "^(?!.*[pP]ubSub)"]
   },
   "overrides": [
     {
@@ -99,6 +100,12 @@
           }
         ]
       }
+    },
+    {
+      "files": ["**/ci/*.js"],
+      "rules": {
+        "no-undef": "off"
+      }
     }
   ]
 }

.github/dependabot.yml

@@ -5,7 +5,6 @@ updates:
     open-pull-requests-limit: 2
     schedule:
       interval: "daily"
-    reviewers: ["fryorcraken","danisharora099","weboko"]
     versioning-strategy: increase
     commit-message:
       prefix: "chore(deps)"

.github/workflows/pre-release.yml

@@ -0,0 +1,25 @@
+on:
+    workflow_dispatch:
+
+jobs:
+    pre-release:
+        name: pre-release
+        runs-on: ubuntu-latest
+        if: github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/master'
+        steps:
+          - uses: actions/checkout@v3
+            with: 
+              repository: waku-org/js-waku
+    
+          - uses: actions/setup-node@v3
+            with:
+              node-version: ${{ env.NODE_JS }}
+              registry-url: "https://registry.npmjs.org"
+    
+          - run: npm install
+    
+          - run: npm run build
+    
+          - run: npm run publish -- --tag next
+            env:
+              NODE_AUTH_TOKEN: ${{ secrets.NPM_JS_WAKU_PUBLISH }}

.github/workflows/test-node.yml

@@ -97,3 +97,11 @@ jobs:
         with:
           name: ${{ inputs.test_type }}-logs
           path: packages/tests/log/
+
+      - name: Create test summary
+        if: always() && env.ALLURE_REPORTS == 'true'
+        run: |
+          echo "## Run Information" >> $GITHUB_STEP_SUMMARY
+          echo "- **NWAKU**: ${{ env.WAKUNODE_IMAGE }}" >> $GITHUB_STEP_SUMMARY
+          echo "## Test Results" >> $GITHUB_STEP_SUMMARY
+          echo "Allure report will be available at: https://waku-org.github.io/allure-jswaku/${{ github.run_number }}" >> $GITHUB_STEP_SUMMARY

.release-please-manifest.json

@@ -1,13 +1,13 @@
 {
-  "packages/utils": "0.0.12",
+  "packages/utils": "0.0.13",
   "packages/proto": "0.0.5",
-  "packages/interfaces": "0.0.19",
-  "packages/message-hash": "0.1.8",
-  "packages/enr": "0.0.18",
-  "packages/peer-exchange": "0.0.17",
-  "packages/core": "0.0.24",
-  "packages/dns-discovery": "0.0.18",
-  "packages/message-encryption": "0.0.22",
-  "packages/relay": "0.0.7",
-  "packages/sdk": "0.0.20"
+  "packages/interfaces": "0.0.20",
+  "packages/message-hash": "0.1.9",
+  "packages/enr": "0.0.19",
+  "packages/peer-exchange": "0.0.18",
+  "packages/core": "0.0.25",
+  "packages/dns-discovery": "0.0.19",
+  "packages/message-encryption": "0.0.23",
+  "packages/relay": "0.0.8",
+  "packages/sdk": "0.0.21"
 }

CONTRIBUTING.md

@@ -60,3 +60,12 @@ Commit messages should never contain any `@` mentions (usernames prefixed with "
 
 Please refer to the [Git manual](https://git-scm.com/doc) for more information
 about Git.
+
+### Releasing
+
+`js-waku` has two types of releases:
+- public releases;
+- pre releases;
+
+Public releases happen by merging PRs opened by `release-please` action.
+Pre releases happen manually by triggering [this workflow](https://github.com/waku-org/js-waku/actions/workflows/pre-release.yml)

ci/publish.js

@@ -8,8 +8,13 @@ const PACKAGE_JSON = "package.json";
 // hack to get __dirname
 const DIR = path.dirname(fileURLToPath(import.meta.url));
 
+const NEXT_TAG = "next";
+const LATEST_TAG = "latest";
+const CURRENT_TAG = readPublishTag();
+
 const exec = promisify(cp.exec);
 const readFile = promisify(fs.readFile);
+const writeFile = promisify(fs.writeFile);
 
 run()
   .then(() => {
@@ -23,26 +28,31 @@ async function run() {
   const rootPackage = await readJSON(path.resolve(DIR, "../", PACKAGE_JSON));
   const workspacePaths = rootPackage.workspaces;
 
-  const workspaces = await Promise.all(
-    workspacePaths.map(async (workspacePath) => {
-      const workspaceInfo = await readWorkspace(workspacePath);
-      const allowPublishing = await shouldBePublished(workspaceInfo);
+  if (CURRENT_TAG === NEXT_TAG) {
+    await makeReleaseCandidate();
+  }
 
-      if (allowPublishing) {
-        return workspaceInfo;
-      }
+  const workspaces = await Promise.all(workspacePaths.map(readWorkspace));
 
-      return;
-    })
-  );
+  if (CURRENT_TAG === NEXT_TAG) {
+    await upgradeWakuDependencies(workspaces);
+  }
 
   await Promise.all(
     workspaces
-      .filter((v) => !!v)
+      .filter(async (info) => {
+        const allowPublishing = await shouldBePublished(info);
+
+        if (allowPublishing) {
+          return true;
+        }
+
+        return false;
+      })
       .map(async (info) => {
         try {
           await exec(
-            `npm publish --workspace ${info.workspace} --tag latest --access public`
+            `npm publish --workspace ${info.workspace} --tag ${CURRENT_TAG} --access public`
           );
           console.info(
             `Successfully published ${info.workspace} with version ${info.version}.`
@@ -61,6 +71,11 @@ async function readJSON(path) {
   return JSON.parse(rawJSON);
 }
 
+async function writeWorkspace(packagePath, text) {
+  const resolvedPath = path.resolve(DIR, "../", packagePath, PACKAGE_JSON);
+  await writeFile(resolvedPath, text);
+}
+
 async function readWorkspace(packagePath) {
   const json = await readJSON(
     path.resolve(DIR, "../", packagePath, PACKAGE_JSON)
@@ -70,13 +85,14 @@ async function readWorkspace(packagePath) {
     name: json.name,
     private: !!json.private,
     version: json.version,
-    workspace: packagePath
+    workspace: packagePath,
+    rawPackageJson: json
   };
 }
 
 async function shouldBePublished(info) {
   if (info.private) {
-    console.info(`Skipping ${info.path} because it is private.`);
+    console.info(`Skipping ${info.name} because it is private.`);
     return false;
   }
 
@@ -99,3 +115,60 @@ async function shouldBePublished(info) {
     );
   }
 }
+
+async function makeReleaseCandidate() {
+  try {
+    console.info("Marking workspace versions as release candidates.");
+    await exec(
+      `npm version prerelease --preid $(git rev-parse --short HEAD) --workspaces true`
+    );
+  } catch (e) {
+    console.error("Failed to mark release candidate versions.", e);
+  }
+}
+
+function readPublishTag() {
+  const args = process.argv.slice(2);
+  const tagIndex = args.indexOf("--tag");
+
+  if (tagIndex !== -1 && args[tagIndex + 1]) {
+    return args[tagIndex + 1];
+  }
+
+  return LATEST_TAG;
+}
+
+async function upgradeWakuDependencies(workspaces) {
+  console.log("Upgrading Waku dependencies in workspaces.");
+  const map = workspaces.reduce((acc, item) => {
+    if (!item.private) {
+      acc[item.name] = item;
+    }
+    return acc;
+  }, {});
+  const packageNames = Object.keys(map);
+  workspaces.forEach(async (info) => {
+    if (info.private) {
+      return;
+    }
+    ["dependencies", "devDependencies", "peerDependencies"].forEach((type) => {
+      const deps = info.rawPackageJson[type];
+      if (!deps) {
+        return;
+      }
+      packageNames.forEach((name) => {
+        if (deps[name]) {
+          deps[name] = map[name].version;
+        }
+      });
+    });
+    try {
+      await writeWorkspace(info.workspace, JSON.stringify(info.rawPackageJson));
+    } catch (error) {
+      console.error(
+        `Failed to update package.json for ${info.name} with: `,
+        error
+      );
+    }
+  });
+}