fix(push-to-ipfs): manual request for ipfs push (#12)

Author: gmolki

push-to-ipfs/action.yaml

@@ -3,21 +3,36 @@ description: Push directory to IPFS
 
 inputs:
   upload-dir:
-    description: 'Directory to upload'
+    description: "Directory to upload"
     required: true
 
 runs:
-  using: 'composite'
+  using: "composite"
   steps:
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: 3.11
+
+    - name: Install dependencies
+      run: |
+        pip install -r ${{ github.action_path }}/scripts/requirements.txt
+      shell: bash
+
     - name: Push to IPFS
       id: push_to_ipfs
       shell: bash
       run: |
-        pip install 'aioipfs>=0.6.2'
-        CID=$(python3 ${{ github.action_path }}/scripts/push_on_ipfs.py "${{ github.workspace }}/${{ inputs.upload-dir }}")
-        echo "CID: $CID" >> $GITHUB_STEP_SUMMARY
-        echo "cid=$CID" >> $GITHUB_OUTPUT
+        result=$(python3 ${{ github.action_path }}/scripts/push_on_ipfs.py "${{ github.workspace }}/${{ inputs.upload-dir }}")
+        echo "CID V0: $(echo $result | jq -r '.cid_v0')" >> $GITHUB_STEP_SUMMARY
+        echo "CID V1: $(echo $result | jq -r '.cid_v1')" >> $GITHUB_STEP_SUMMARY
+        echo "cid_v0=$(echo $result | jq -r '.cid_v0')" >> $GITHUB_OUTPUT
+        echo "cid_v1=$(echo $result | jq -r '.cid_v1')" >> $GITHUB_OUTPUT
+
 outputs:
-  cid:
-    description: 'IPFS CID'
-    value: ${{ steps.push_to_ipfs.outputs.cid }}
+  cid_v0:
+    description: "IPFS CID V0"
+    value: ${{ steps.push_to_ipfs.outputs.cid_v0 }}
+  cid_v1:
+    description: "IPFS CID V0"
+    value: ${{ steps.push_to_ipfs.outputs.cid_v1 }}

push-to-ipfs/scripts/push_on_ipfs.py

@@ -1,65 +1,46 @@
 #!/usr/bin/env python3
-
-"""
-This script uploads the build SPA to IPFS.
-It does not ping it or do anything else yet, so the result can only be accessed
- as long as the files are not garbage collected.
-Requires: 'aioipfs>=0.6.2'
-"""
-
-import asyncio
-import logging
+import requests
+import json
 import sys
 from pathlib import Path
-from typing import NewType
-
-import aioipfs
-
-logger = logging.getLogger(__file__)
-
-Multiaddr = NewType("Multiaddr", str)
-CID = NewType("CID", str)
-
+from cid import make_cid
+
+def upload_with_requests(folder: Path, gateway: str):
+    url = f"{gateway}/api/v0/add"
+    params = {
+        "recursive": "true",
+        "wrap-with-directory": "true"
+    }
+
+    # Prepare file data like curl -F file=@./dist/
+    files = []
+    for path in folder.rglob("*"):
+        if path.is_file():
+            relative_path = path.relative_to(folder.parent)
+            files.append(
+                ("file", (str(relative_path), open(path, "rb")))
+            )
 
-def raise_no_cid():
-    raise ValueError("Could not obtain a CID")
+    response = requests.post(url, params=params, files=files)
+    response.raise_for_status()
 
+    # Parse the response line-by-line
+    cid_v0 = None
+    for line in response.text.strip().splitlines():
+        entry = json.loads(line)
+        cid_v0 = entry.get("Hash")
 
-async def upload_site(files: list[Path], multiaddr: Multiaddr) -> CID:
-    client = aioipfs.AsyncIPFS(
-        maddr=multiaddr,
-        read_timeout=900,
-    )
+    if not cid_v0:
+        raise RuntimeError("CID not found in response.")
 
-    try:
-        cid = None
-        async for added_file in client.add(*files, recursive=True):
-            logger.debug(
-                f"Uploaded file {added_file['Name']} with CID: {added_file['Hash']}"
-            )
-            cid = added_file["Hash"]
-        # The last CID is the CID of the directory uploaded
-        return cid or raise_no_cid()
-    finally:
-        await client.close()
+    cid_v1 = make_cid(cid_v0).to_v1().encode("base32").decode()
+    return {"cid_v0": cid_v0, "cid_v1": cid_v1}
 
-
-async def publish_site(path: Path, multiaddr: Multiaddr) -> CID:
+if __name__ == "__main__":
+    path = Path(sys.argv[1])
     if not path.is_dir():
-        raise NotADirectoryError(f"No such directory: {path}")
-    cid = await upload_site(files=[path], multiaddr=multiaddr)
-    return cid
-
-
-def main():
-    if len(sys.argv) != 2:
-        print(f"Usage: {Path(__file__).name} <directory>")
+        print("Error: path must be a directory")
         sys.exit(1)
 
-    directory = Path(sys.argv[1]).resolve()
-    print(asyncio.run(publish_site(directory, Multiaddr("/dns4/ipfs-2.aleph.im/tcp/443/https"))))
-
-
-if __name__ == "__main__":
-    logging.basicConfig(level=logging.INFO)
-    main()
+    result = upload_with_requests(path.resolve(), "https://ipfs-2.aleph.im")
+    print(json.dumps(result))

push-to-ipfs/scripts/requirements.txt

@@ -0,0 +1,2 @@
+requests==2.32.4
+py-cid==0.3.0