fix: handle binary content properly (#9)

Signed-off-by: Xavier Krantz <xavier.krantz@datadome.co>

Author: xakraz

README.md

@@ -76,6 +76,15 @@ Note: The `GH_TOKEN` environment variable is **required** for GitHub API request
 | `commit-sha` | Full SHA of the signed commit. |
 | `tag` | Tag of the signed commit. |
 
+## Release
+
+This project follows [Conventional Commits](https://www.conventionalcommits.org/) and uses a manual release workflow.
+
+1. Ensure `dist/` is up-to-date by running `npm run bundle`
+2. Trigger the **Release** workflow via `workflow_dispatch` with the desired [semver](https://semver.org/) version
+    - The workflow bumps `package.json`, creates a signed commit, and tags `v{version}`
+3. The **Changelog** workflow automatically regenerates `CHANGELOG.md` from conventional commits using [git-cliff](https://git-cliff.org/)
+
 [ci_badge]: https://github.com/ryancyq/github-signed-commit/actions/workflows/ci.yml/badge.svg
 [ci_workflows]: https://github.com/ryancyq/github-signed-commit/actions/workflows/ci.yml
 [coverage_badge]: https://codecov.io/gh/ryancyq/github-signed-commit/graph/badge.svg?token=KZTD2F2MN2

__tests__/blob.test.ts

@@ -86,6 +86,23 @@ describe('Blob', () => {
       })
     })
 
+    it('binary file successfully', async () => {
+      const binaryContent = Buffer.from([
+        0x89, 0x50, 0x4e, 0x47, 0x0d, 0x0a, 0x1a, 0x0a, 0xff, 0xfe, 0x00, 0x80,
+        0xc0, 0xc1, 0xf5, 0xf6,
+      ])
+      const binaryPath = join(__dirname, 'fixtures', 'blob.bin')
+      fs.writeFileSync(binaryPath, binaryContent)
+
+      try {
+        const blob = getBlob('fixtures/blob.bin')
+        const fileAddition = await blob.load()
+        expect(fileAddition.contents).toEqual(binaryContent.toString('base64'))
+      } finally {
+        fs.unlinkSync(binaryPath)
+      }
+    })
+
     it('stream with error', async () => {
       const blob = getBlob('fixtures/error.txt')
       const mockStream = new PassThrough()

__tests__/main.test.ts

@@ -205,42 +205,6 @@ describe('action', () => {
     })
   })
 
-  describe('input repository is given', () => {
-    describe('valid format', () => {
-      beforeEach(() => {
-        jest.spyOn(core, 'getInput').mockImplementation((name, _option) => {
-          if (name == 'repository') return 'the-user/the-repo'
-          return ''
-        })
-      })
-
-      it('succeed', async () => {
-        const setFailedMock = jest.spyOn(core, 'setFailed').mockReturnValue()
-        await main.run()
-        expect(setFailedMock).toHaveBeenCalledWith(
-          'Neither files nor tag input has been configured'
-        )
-      })
-    })
-
-    describe('invalid format', () => {
-      beforeEach(() => {
-        jest.spyOn(core, 'getInput').mockImplementation((name, _option) => {
-          if (name == 'repository') return 'the-user-the-repo'
-          return ''
-        })
-      })
-
-      it('fails', async () => {
-        const setFailedMock = jest.spyOn(core, 'setFailed').mockReturnValue()
-        await main.run()
-        expect(setFailedMock).toHaveBeenCalledWith(
-          'Input <repository> "the-user-the-repo" is invalid'
-        )
-      })
-    })
-  })
-
   describe('input branch is given', () => {
     beforeEach(() => {
       jest.spyOn(core, 'getMultilineInput').mockReturnValue(['/test.txt'])

__tests__/stream/base64-encoder.test.ts

@@ -15,4 +15,18 @@ describe('Base64 Encoder', () => {
     const streamedContent = Buffer.concat(chunks).toString('utf8')
     expect(streamedContent).toEqual(Buffer.from(content).toString('base64'))
   })
+
+  it('binary buffer stream', async () => {
+    const binaryContent = Buffer.from([
+      0x89, 0x50, 0x4e, 0x47, 0xff, 0xfe, 0x00, 0x80, 0xc0, 0xc1,
+    ])
+    const stream = Readable.from(binaryContent).pipe(new Base64Encoder())
+
+    const chunks: Buffer[] = []
+    for await (const chunk of stream) {
+      chunks.push(Buffer.isBuffer(chunk) ? chunk : Buffer.from(chunk))
+    }
+    const streamedContent = Buffer.concat(chunks).toString('utf8')
+    expect(streamedContent).toEqual(binaryContent.toString('base64'))
+  })
 })